openapi: 3.0.1
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
info:
  contact:
    name: Bo Li
    email: bo_kwong@yahoo.com
  description: Pay distributions (direct deposit configuration) determine how a worker's pay is divided (e.g. 50% to savings,
    25% to checking, $100 on a paycard, and the remainder in check). The Pay Distributions APIs can be used to change how
    a worker's pay is distributed, retrieve a single distribution or list all distributions, or to obtain API metadata.
    &nbsp;For more information, see <a href="https://developers.adp.com/articles/guides/direct-deposit-api-guide-for-adp-workforce-now"
    rel="noopener noreferrer" target="_blank">Direct Deposit API Guide for ADP Workforce Now</a>
  title: Worker Pay Distributions
  version: 2.0.8
  x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/payroll/pay-distributions/v2/pay-distributions-swagger_v2-merged.json
  x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn)
  x-apievangelist-resource-path: payroll/pay-distributions/v2/pay-distributions
x-adpSpecData:
  domain: Payroll
  specId: 7cc7e0dd-3d6b-4cec-aec2-88b5ef31fd1b
  canonicalSpecId: bd783fb9-4132-4966-bd73-23a01452cb16
  specStatusCode: publishing
  specTypeCode: REST
  specStateCode: active
  nonStandardIndicator: false
  visibilityCodes:
  - internal
  - external
  filename: pay-distributions-swagger_v2-merged.json
  serviceProviderId: WFN
  resourcePath: payroll/pay-distributions/v2
  libraryVersion: ''
  businessRules:
  - 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: R2.3
    ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective
    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: 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: 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: 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: 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: R3.3
    ruleTitle: /data/output communicates the result of the event instance.
    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: 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: 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: 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: R6.1
    ruleTitle: An event instance which is being “worked on” has an event.status.code=inprogress
    visibilityCodes:
    - internal
  - rule: R11.1
    ruleTitle: '''associateoid'' in the uri pattern should match the ''associateoid'' in the request header parameter'
    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: R1.0
    ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete
    visibilityCodes:
    - internal
  - rule: R5.0
    ruleTitle: Meta returns the context rules for each data section
    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: 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: R6.2
    ruleTitle: An event instance which has been recorded has an event.status.code=complete
    visibilityCodes:
    - internal
  - rule: R8.1
    ruleTitle: An event notification includes the /data/eventContext and /data/output objects.
    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: R3.4
    ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results.
    visibilityCodes:
    - internal
  - rule: R3.5
    ruleTitle: A complete event has /data/eventContext and /data/output
    visibilityCodes:
    - internal
  - rule: US Bank Routing ID
    ruleTitle: '**Masking [Pattern:](/library/patterns/#revealmasked)** XXXXXXXX (all masked)  **Reveal Canonical ID: **  /core/accessManagement/sensitiveDataManagement/financialAccountManagement/usFinancialPartyRoutingID.reveal'
    visibilityCodes:
    - internal
  - rule: US Account ID
    ruleTitle: '**Masking [Pattern:](/library/patterns/#revealmasked)** XXXXX-678 (show last 4 chars)  **Reveal Operation
      Canonical ID: **  /core/accessManagement/sensitiveDataManagement/financialAccountManagement/usFinancialAccountID.reveal'
    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: 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.2
    ruleTitle: An event notification does not include the transform or meta objects.
    visibilityCodes:
    - internal
  testCaseCollection:
    example:
      href: WFN_CG_Worker_PayDistributions.postman_collection.json
    description: Pay Distributions Postman collection
  publicationContext:
    products:
    - productId: hcm-offrg-wfn
      productName: workforce now
      marketplaceProductName: ADP Workforce Now®
  specCategoryCode: ''
tags:
- name: Change Pay Distribution
  description: Pay distribution change management events
- name: Pay Distributions
  description: List all pay distributions
paths:
  /payroll/v2/workers/{aoid}/pay-distributions:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: payDistributionManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Pay Distributions
    get:
      summary: Pay Distributions
      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:
        - MobileMSSPayDistribution
        - MobilePSSPayDistribution
        - MobileESSPayDistribution
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/payDistributionManagement/worker.payDistribution.read
        operationCode: worker.payDistribution.read
        operationId: ade9efcb-49b5-4af3-b3ba-eab61ff077f7
        performAuthIndicator: true
        roleCodes:
        - manager
        - practitioner
        - employee
        scenarios:
        - summary: Retrieve a list of direct deposits
          name: Retrieve a list of direct deposits
          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: The requester doesn't have access to reveal sensitive data, such as Routing Number and Account Number
              to make a GET call unmask data
            content:
              application/json:
                externalValue: ./examples/Retrieve_a_list_of_direct_deposits_Provide_Example_worker.payDistribution.read_200_44012.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Request all available pay distributions for a worker
            content:
              application/json:
                externalValue: ./examples/Retrieve_a_list_of_direct_deposits_Provide_Example_worker.payDistribution.read_200_44011.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: The requester does have access to reveal sensitive data such as Routing Number and Account Number
              to make a GET call unmask data.
            content:
              application/json:
                externalValue: ./examples/Retrieve_a_list_of_direct_deposits_Provide_Example_worker.payDistribution.read_200_44013.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: an employee having multiple positions (both primary and non primary).
            content:
              application/json:
                externalValue: ./examples/Retrieve_a_list_of_direct_deposits_Provide_Example_worker.payDistribution.read_200_44016.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '204'
            description: The GET /payroll/v2/workers /{aoid}/pay-distributions returns 204 response for an AOID, which doesn't
              get paid.
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '403'
            description: Requested Associate ID is invalid
            content:
              application/json:
                externalValue: ./examples/Retrieve_a_list_of_direct_deposits_Provide_Example_worker.payDistribution.read_403_44017.json
          description: Retrieve a list of direct deposits
        - summary: 'Retrieve direct deposit with effective date in the future. &nbsp;<a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(250, 245, 240); color: rgb(74, 144, 226); text-decoration:
            none; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>/payroll/v2/workers&nbsp;</a><a
            href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style=''box-sizing: border-box; background-color:
            rgb(250, 245, 240); color: rgb(74, 144, 226); text-decoration: none; font-family: TaubSans, "sans-serif"; font-size:
            16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing:
            normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2;
            word-spacing: 0px; -webkit-text-stroke-width: 0px;''>{aoid}/pay-distributions?</a><span style=''color: rgb(34,
            34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(250, 245, 240); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;</span><a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(250, 245, 240); color: rgb(35, 82, 124); text-decoration:
            none; outline: 0px; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>effectiveDate={effectivedate}</a><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(250, 245, 240); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;returns the future dated Direct Deposits.</span>'
          name: Retrieve future dated direct deposit
          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: GET /payroll/v2/workers {aoid}/pay-distributions? effectiveDate={effectivedate} returns the future
              dated Direct Deposits.
            content:
              application/json:
                externalValue: ./examples/Retrieve_future_dated_direct_deposit_Provide_Example_worker.payDistribution.read_200_44014.json
          description: 'Retrieve direct deposit with effective date in the future. &nbsp;<a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(250, 245, 240); color: rgb(74, 144, 226); text-decoration:
            none; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>/payroll/v2/workers&nbsp;</a><a
            href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style=''box-sizing: border-box; background-color:
            rgb(250, 245, 240); color: rgb(74, 144, 226); text-decoration: none; font-family: TaubSans, "sans-serif"; font-size:
            16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing:
            normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2;
            word-spacing: 0px; -webkit-text-stroke-width: 0px;''>{aoid}/pay-distributions?</a><span style=''color: rgb(34,
            34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(250, 245, 240); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;</span><a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(250, 245, 240); color: rgb(35, 82, 124); text-decoration:
            none; outline: 0px; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>effectiveDate={effectivedate}</a><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(250, 245, 240); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;returns the future dated Direct Deposits.</span>'
        - summary: '<p><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style:
            normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans:
            2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px;
            -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style:
            initial; text-decoration-color: initial; display: inline !important; float: none;''>GET&nbsp;</span><a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(255, 255, 255); color: rgb(74, 144, 226); text-decoration:
            none; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>/payroll/v2/workers</a><a
            href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style=''box-sizing: border-box; background-color:
            rgb(255, 255, 255); color: rgb(35, 82, 124); text-decoration: none; outline: 0px; font-family: TaubSans, "sans-serif";
            font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300;
            letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal;
            widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>{aoid} /paydistributions?inactive= {status}</a><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;returns the Direct Deposits as of status.</span></p><p><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''><strong>Note</strong></span></p><p><span style=''color: rgb(34,
            34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>Your application must retrieve Active or Inactive records
            separately. &nbsp;</span></p>'
          name: Retrieve list of direct deposit with a specific status
          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: Request all available pay distributions for a worker
            content:
              application/json:
                externalValue: ./examples/Retrieve_list_of_direct_deposit_with_a_specific_status_Provide_Example_worker.payDistribution.read_200_44015.json
          description: '<p><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style:
            normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans:
            2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px;
            -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style:
            initial; text-decoration-color: initial; display: inline !important; float: none;''>GET&nbsp;</span><a href="https://developers.adp.com/articles/api/pay-distributions-v2-api"
            style=''box-sizing: border-box; background-color: rgb(255, 255, 255); color: rgb(74, 144, 226); text-decoration:
            none; font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>/payroll/v2/workers</a><a
            href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style=''box-sizing: border-box; background-color:
            rgb(255, 255, 255); color: rgb(35, 82, 124); text-decoration: none; outline: 0px; font-family: TaubSans, "sans-serif";
            font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300;
            letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal;
            widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;''>{aoid} /paydistributions?inactive= {status}</a><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>&nbsp;returns the Direct Deposits as of status.</span></p><p><span
            style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
            normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''><strong>Note</strong></span></p><p><span style=''color: rgb(34,
            34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal;
            font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
            0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px;
            background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
            initial; display: inline !important; float: none;''>Your application must retrieve Active or Inactive records
            separately. &nbsp;</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
                - 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
                - external
              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
            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
                - external
              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 all available pay distributions for a worker
          content:
            application/json:
              schema:
                $ref: ./schemas/payDistributions_schema_v02_00_rev009.json
        '400':
          $ref: '#/components/responses/400'
        '500':
          $ref: '#/components/responses/500'
        '412':
          $ref: '#/components/responses/412'
        '204':
          $ref: '#/components/responses/204'
        '413':
          $ref: '#/components/responses/413'
        '304':
          $ref: '#/components/responses/304'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: '<p><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style:
        normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans:
        2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width:
        0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
        initial; display: inline !important; float: none;''>Returns the list of all active deposits (until current effective
        date) for an employee.</span></p><p><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size:
        16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing:
        normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing:
        0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style:
        initial; text-decoration-color: initial; display: inline !important; float: none;''><span style=''color: rgb(34, 34,
        34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps:
        normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform:
        none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255,
        255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; display:
        inline !important; float: none;''>To address privacy concerns, clients can configure if to allow a user access bank
        account number and routing numbers.&nbsp;</span><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif";
        font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300;
        letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal;
        widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness:
        initial; text-decoration-style: initial; text-decoration-color: initial; display: inline !important; float: none;''>By
        default,&nbsp;</span><strong style=''box-sizing: border-box; font-weight: 600; color: rgb(34, 34, 34); font-family:
        TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal;
        letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal;
        widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness:
        initial; text-decoration-style: initial; text-decoration-color: initial;''>Account Number</strong><span style=''color:
        rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
        normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent:
        0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color:
        rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;
        display: inline !important; float: none;''>&nbsp;and&nbsp;</span><strong style=''box-sizing: border-box; font-weight:
        600; color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures:
        normal; font-variant-caps: normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform:
        none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255,
        255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;''>Routing
        Numbe</strong><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size: 16px; font-style:
        normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing: normal; orphans:
        2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width:
        0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
        initial; display: inline !important; float: none;''>r are masked in the Direct Deposit API response. To reveal masked
        data, simply add the following header to your HTTP request:</span></span></p><p><span style=''color: rgb(34, 34, 34);
        font-family: TaubSans, "sans-serif"; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps:
        normal; font-weight: 300; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform:
        none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255,
        255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; display:
        inline !important; float: none;''><span style=''color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-size:
        16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 300; letter-spacing:
        normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing:
        0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style:
        initial; text-decoration-color: initial; display: inline !important; float: none;''><strong>Accept:application/json;masked=false</strong></span></span></p>'
      operationId: ade9efcb-49b5-4af3-b3ba-eab61ff077f7
      parameters:
      - 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-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: G4O73G9Z62SL2NFM
          type: string
        in: path
        name: aoid
        description: Associate OID
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ISI
          type: string
        in: header
        name: realm
        description: The identity management realm, e.g. ISI
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - 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
        required: false
      - 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: 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: CONSUMERAOID
        description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming
          the Web API.  Conditions: Required/applicable security standard uses this header. Internal to ADP'
        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_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
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: CONSUMEROOID
        description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer
          application belongs.  Conditions: Required/applicable security standard uses this header.  Internal to ADP'
        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: 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
        required: true
      - 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
          - 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: SORUri
        description: Actual Uri within the SOR
        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: ''
          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: 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: 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: 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: active
          type: string
        in: query
        name: status
        description: 'This parameter allows for the retrieval of pay distributions of a given status (or statuses) in the
          practitioner context only.  Allowed values: active, inactive, all.  If the parameter is omitted all distributions,
          including pending (if applicable) should be returned.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: true
      - 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: 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: 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: ADP-Context-ExpressionID
        description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: query
        name: asOfDate
        description: This parameter allows for the retrieval of pay distributions as of given date. If the parameter is omitted
          the distributions, as of current date should be returned.
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      tags:
      - Pay Distributions
  /events/payroll/v1/worker.pay-distribution.change/meta:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: payDistributionManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Change Pay Distribution
    get:
      summary: Change Pay Distribution 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:
        - MobileMSSPayDistribution
        - MobileESSPayDistribution
        - MobilePSSPayDistribution
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/payDistributionManagement/worker.payDistribution.change
        operationCode: worker.payDistribution.change
        operationId: 64b8cddd-86b7-4851-bd6a-8caf12e24ca0
        performAuthIndicator: true
        roleCodes:
        - manager
        - employee
        - practitioner
        scenarios:
        - summary: Retrieve meta for the request in order to dynamically built out request payload
          name: Retrieve meta for the request
          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 an event metadata
            content:
              application/json:
                externalValue: ./examples/Retrieve_meta_for_the_request_Provide_Example_worker.payDistribution.change_200_44019.json
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Meta Response for Canada Clients
            content:
              application/json:
                externalValue: ./examples/Retrieve_meta_for_the_request_Custom_Example_worker.payDistribution.change_200_493579.json
          description: Retrieve meta for the request in order to dynamically built out request payload
        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
                - 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
                - external
              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
            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
                - external
              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.payDistribution.change_meta_schema_v01_00_rev011.json
        '400':
          $ref: '#/components/responses/400'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        '413':
          $ref: '#/components/responses/413'
        '304':
          $ref: '#/components/responses/304'
        '403':
          $ref: '#/components/responses/403'
        '503':
          $ref: '#/components/responses/503'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: Returns an event metadata
      operationId: 64b8cddd-86b7-4851-bd6a-8caf12e24ca0
      parameters:
      - 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-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: 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
        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
      - 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: 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: CONSUMERAOID
        description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming
          the Web API.  Conditions: Required/applicable security standard uses this header. Internal to ADP'
        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: 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_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
          - external
        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: ''
          type: string
        in: header
        name: CONSUMEROOID
        description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer
          application belongs.  Conditions: Required/applicable security standard uses this header.  Internal to ADP'
        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: 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
        required: true
      - 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
          - 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: SORUri
        description: Actual Uri within the SOR
        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: ''
          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: 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: 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: 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: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        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: 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
      tags:
      - Change Pay Distribution
  /events/payroll/v1/worker.pay-distribution.change:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: payDistributionManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Change Pay Distribution
    post:
      summary: Change Pay Distribution
      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:
        - MobilePSSPayDistribution
        - MobileMSSPayDistribution
        - MobileESSPayDistribution
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/payDistributionManagement/worker.payDistribution.change
        operationCode: worker.payDistribution.change
        operationId: fb5b93af-6949-4acc-8ee0-c817ac90fbb0
        performAuthIndicator: true
        roleCodes:
        - practitioner
        - manager
        - employee
        scenarios:
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 5. Add DD with Priority
          responses:
          - headers:
              ADP-Acting-Session-Expires: ''
              Cache-Control: ''
              sm_transactionid: ''
              ETag: ''
              ADP-Acting-SessionID: ''
              Content-Type: ''
            code: '200'
            description: Direct Deposit was added.
            content:
              application/json:
                externalValue: ./examples/5._Add_DD_with_Priority_Custom_Example_worker.payDistribution.change_200_493555.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/5._Add_DD_with_Priority_Custom_Example_worker.payDistribution.change_request_45579.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 10. Updating DD with Amount to deposit as Percent Net
          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: Direct Deposit was updated successfully
            content:
              application/json:
                externalValue: ./examples/10._Updating_DD_with_Amount_to_deposit_as_Percent_Net_Custom_Example_worker.payDistribution.change_200_493560.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/10._Updating_DD_with_Amount_to_deposit_as_Percent_Net_Custom_Example_worker.payDistribution.change_request_45584.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 20. Add DD with Priority (Canadian Clients)
          responses:
          - headers:
              ADP-Acting-Session-Expires: ''
              Cache-Control: ''
              sm_transactionid: ''
              ETag: ''
              ADP-Acting-SessionID: ''
              Content-Type: ''
            code: '200'
            description: Direct Deposit was added with priority.
            content:
              application/json:
                externalValue: ./examples/20._Add_DD_with_Priority_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493570.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/20._Add_DD_with_Priority_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45594.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 19. Adding DD with Multiple Deposit Codes (Canadian Clients)
          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: Multiple Direct Deposit codes were added,
            content:
              application/json:
                externalValue: ./examples/19._Adding_DD_with_Multiple_Deposit_Codes_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493569.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/19._Adding_DD_with_Multiple_Deposit_Codes_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45593.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 23. Updating DD with Amount to deposit as Percentage net ( Canadian Clients)
          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: Direct Deposit was updated.
            content:
              application/json:
                externalValue: ./examples/23._Updating_DD_with_Amount_to_deposit_as_Percentage_net_(_Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493574.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/23._Updating_DD_with_Amount_to_deposit_as_Percentage_net_(_Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45598.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 27. Removing Direct Deposit (Canadian Client)
          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: Direct Deposit was removed.
            content:
              application/json:
                externalValue: ./examples/27._Removing_Direct_Deposit_(Canadian_Client)_Custom_Example_worker.payDistribution.change_200_493578.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/27._Removing_Direct_Deposit_(Canadian_Client)_Custom_Example_worker.payDistribution.change_request_45602.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 3. Adding DD with Amount to deposit as Full Net
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/3._Adding_DD_with_Amount_to_deposit_as_Full_Net_Custom_Example_worker.payDistribution.change_200_493553.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/3._Adding_DD_with_Amount_to_deposit_as_Full_Net_Custom_Example_worker.payDistribution.change_request_45577.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 9. Adding DD with Prenote as Custom
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/9._Adding_DD_with_Prenote_as_Custom_Custom_Example_worker.payDistribution.change_200_493559.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/9._Adding_DD_with_Prenote_as_Custom_Custom_Example_worker.payDistribution.change_request_45583.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 26. Update DD from Active to Inactive (Canadian Clients)
          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: Direct Deposit was updated.
            content:
              application/json:
                externalValue: ./examples/26._Update_DD_from_Active_to_Inactive_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493577.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/26._Update_DD_from_Active_to_Inactive_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45601.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 7. Adding DD with Prenote as Company Default
          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: Direct Deposit was added successfully.
            content:
              application/json:
                externalValue: ./examples/7._Adding_DD_with_Prenote_as_Company_Default_Custom_Example_worker.payDistribution.change_200_493557.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/7._Adding_DD_with_Prenote_as_Company_Default_Custom_Example_worker.payDistribution.change_request_45581.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 21. Adding DD as Bonus pay (Canadian Clients)
          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: A worker changes how the pay is distributed for a given payroll agreement
            content:
              application/json:
                externalValue: ./examples/21._Adding_DD_as_Bonus_pay_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493571.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/21._Adding_DD_as_Bonus_pay_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45595.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 12. Updating DD with Amount to deposit as Full Net
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/12._Updating_DD_with_Amount_to_deposit_as_Full_Net_Custom_Example_worker.payDistribution.change_200_493562.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/12._Updating_DD_with_Amount_to_deposit_as_Full_Net_Custom_Example_worker.payDistribution.change_request_45586.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 2. Add DD with Amount to deposit as Partial Net
          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: A Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/2._Add_DD_with_Amount_to_deposit_as_Partial_Net_Custom_Example_worker.payDistribution.change_200_493552.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/2._Add_DD_with_Amount_to_deposit_as_Partial_Net_Custom_Example_worker.payDistribution.change_request_45576.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 24. Update DD with Amount to deposit as Full Net (Canadian Clients)
          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: Direct Deposit was updated
            content:
              application/json:
                externalValue: ./examples/24._Update_DD_with_Amount_to_deposit_as_Full_Net_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493575.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/24._Update_DD_with_Amount_to_deposit_as_Full_Net_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45599.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 11. Updating DD with Amount to deposit as Partial Net
          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: Direct Deposit was updated successfully
            content:
              application/json:
                externalValue: ./examples/11._Updating_DD_with_Amount_to_deposit_as_Partial_Net_Custom_Example_worker.payDistribution.change_200_493561.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/11._Updating_DD_with_Amount_to_deposit_as_Partial_Net_Custom_Example_worker.payDistribution.change_request_45585.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 14. Updating DD from Active to Inactive
          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: A worker changes how the pay is distributed for a given payroll agreement
            content:
              application/json:
                externalValue: ./examples/14._Updating_DD_from_Active_to_Inactive_Custom_Example_worker.payDistribution.change_200_493564.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/14._Updating_DD_from_Active_to_Inactive_Custom_Example_worker.payDistribution.change_request_45588.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Add or update direct deposit with Prenote and with BonusPay
          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: Deposit bonus pay with a percentage of 10.
            content:
              application/json:
                externalValue: ./examples/Add_or_update_direct_deposit_with_Prenote_and_with_BonusPay_Provide_Example_worker.payDistribution.change_200_44023.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Add_or_update_direct_deposit_with_Prenote_and_with_BonusPay_Provide_Example_worker.payDistribution.change_request_3674.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 13. Updating DD with Multiple Deposit Codes
          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: Multiple Direct Deposits were updated
            content:
              application/json:
                externalValue: ./examples/13._Updating_DD_with_Multiple_Deposit_Codes_Custom_Example_worker.payDistribution.change_200_493563.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/13._Updating_DD_with_Multiple_Deposit_Codes_Custom_Example_worker.payDistribution.change_request_45587.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 4. Adding DD with Multiple Deposit Codes.
          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: Direct deposit was added successfully.
            content:
              application/json:
                externalValue: ./examples/4._Adding_DD_with_Multiple_Deposit_Codes._Custom_Example_worker.payDistribution.change_200_493554.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/4._Adding_DD_with_Multiple_Deposit_Codes._Custom_Example_worker.payDistribution.change_request_45578.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 8. Adding DD with Prenote as No-Prenote
          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: Direct deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/8._Adding_DD_with_Prenote_as_No-Prenote_Custom_Example_worker.payDistribution.change_200_493558.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/8._Adding_DD_with_Prenote_as_No-Prenote_Custom_Example_worker.payDistribution.change_request_45582.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 15. Removing direct deposit
          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: Direct Deposit was removed successfully
            content:
              application/json:
                externalValue: ./examples/15._Removing_direct_deposit_Custom_Example_worker.payDistribution.change_200_493565.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/15._Removing_direct_deposit_Custom_Example_worker.payDistribution.change_request_45589.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 1. Adding DD with Amount to deposit as Percent Net
          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: Direct Deposit was added successfully.
            content:
              application/json:
                externalValue: ./examples/1._Adding_DD_with_Amount_to_deposit_as_Percent_Net_Custom_Example_worker.payDistribution.change_200_493551.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/1._Adding_DD_with_Amount_to_deposit_as_Percent_Net_Custom_Example_worker.payDistribution.change_request_45575.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 22. Updating DD with Amount to deposit as Partial Net Copy ( Canadian Clients)
          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: Direct Deposit was updated.
            content:
              application/json:
                externalValue: ./examples/22._Updating_DD_with_Amount_to_deposit_as_Partial_Net_Copy_(_Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493572.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/22._Updating_DD_with_Amount_to_deposit_as_Partial_Net_Copy_(_Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45596.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: Add or Update direct deposit for a Canada based client
          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: Request processed
            content:
              application/json:
                externalValue: ./examples/Add_or_Update_direct_deposit_for_a_Canada_based_client_Provide_Example_worker.payDistribution.change_200_44022.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/Add_or_Update_direct_deposit_for_a_Canada_based_client_Provide_Example_worker.payDistribution.change_request_3673.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 18. Adding DD with Amount to deposit as Full Net (Canadian client)
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/18._Adding_DD_with_Amount_to_deposit_as_Full_Net_(Canadian_client)_Custom_Example_worker.payDistribution.change_200_493568.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/18._Adding_DD_with_Amount_to_deposit_as_Full_Net_(Canadian_client)_Custom_Example_worker.payDistribution.change_request_45592.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 25. Updating DD with Multiple Deposit Codes (Canadian Clients)
          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: Multiple direct deposits were updated.
            content:
              application/json:
                externalValue: ./examples/25._Updating_DD_with_Multiple_Deposit_Codes_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493576.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/25._Updating_DD_with_Multiple_Deposit_Codes_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45600.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 16. Add DD with Amount to deposit as Partial Net (canadian clients)
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/16._Add_DD_with_Amount_to_deposit_as_Partial_Net_(canadian_clients)_Custom_Example_worker.payDistribution.change_200_493566.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/16._Add_DD_with_Amount_to_deposit_as_Partial_Net_(canadian_clients)_Custom_Example_worker.payDistribution.change_request_45590.json
        - summary: Request to add a direct deposit with the specified effective date
          name: Add or update direct deposit for a client in U.S.
          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: New direct deposit is added
            content:
              application/json:
                externalValue: ./examples/Add_or_update_direct_deposit_for_a_client_in_U.S._Provide_Example_worker.payDistribution.change_200_44020.json
          description: Request to add a direct deposit with the specified effective date
          content:
            application/json:
              externalValue: ./examples/Add_or_update_direct_deposit_for_a_client_in_U.S._Provide_Example_worker.payDistribution.change_request_3671.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 6. Adding DD as Bonus Pay
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/6._Adding_DD_as_Bonus_Pay_Custom_Example_worker.payDistribution.change_200_493556.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/6._Adding_DD_as_Bonus_Pay_Custom_Example_worker.payDistribution.change_request_45580.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 17. Adding DD with Amount to deposit as Percentage net (Canadian Clients)
          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: Direct Deposit was added successfully
            content:
              application/json:
                externalValue: ./examples/17._Adding_DD_with_Amount_to_deposit_as_Percentage_net_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_200_493567.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/17._Adding_DD_with_Amount_to_deposit_as_Percentage_net_(Canadian_Clients)_Custom_Example_worker.payDistribution.change_request_45591.json
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      requestBody:
        description: posted contents
        content:
          application/json:
            schema:
              $ref: ./schemas/events_payroll.worker.payDistribution.change_schema_v01_00_rev011.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
                - 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
                - external
              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
            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
                - external
              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: A worker changes how the pay is distributed for a given payroll agreement
          content:
            application/json:
              schema:
                $ref: ./schemas/events_payroll.worker.payDistribution.change_schema_v01_00_rev011.json
        '400':
          $ref: '#/components/responses/400'
        '500':
          $ref: '#/components/responses/500'
        '412':
          $ref: '#/components/responses/412'
        '403':
          $ref: '#/components/responses/403'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: '<p>The /events/payroll/v1/worker.pay-distribution.change request replaces an employee&#39;s existing Direct
        Deposit records with an updated array collection in the request payload.&nbsp;</p><p>There are no separate/explicit
        Add, Update, Remove, and Inactivate URI&#39;s. For example, if a new Direct Deposit needs to be added to an existing
        collection, your application needs to first, retrieve the existing collection, then build the request payload with
        the existing collection and insert the new Direct Deposit record in the array. To delete a Direct Deposit, your application
        needs to remove the record from the array and send the rest of the collection in the request payload.&nbsp;</p><p>The
        Direct Deposit API is supported for both U.S. and Canadian clients. The following are the differences between the
        two types of clients:&nbsp;</p><p>For U.S. clients: The Routing Number and Account Number are used to add and update
        a Direct Deposit.&nbsp;</p><p>For Canadian clients: The Bank name and Branch code, along with the Account Number,
        are used to add and update a Direct Deposit.&nbsp;</p><p>Refer the payloads in the API Usage section.&nbsp;</p><p>In
        the given payload (pay-distribution.change_Payload), the following is the purpose of the eventContext and transform
        sections:&nbsp;</p><p>eventContext: A set of keys, identifying the subject. In the payload, the associateID field
        is present under eventContext. The associateID identifies the subject.&nbsp;</p><p>transform: Provides the values
        added or changed with respect to the subject keys defined in the eventContext section..</p>'
      operationId: fb5b93af-6949-4acc-8ee0-c817ac90fbb0
      parameters:
      - 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-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: ADP-Context-ExpressionID
        description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec
        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: 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
        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
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Originator-ApplicationID
        description: Identifier of the application that initiated (i.e. originated) a command 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: 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: 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: CONSUMERAOID
        description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming
          the Web API.  Conditions: Required/applicable security standard uses this header. Internal to ADP'
        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_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
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: CONSUMEROOID
        description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer
          application belongs.  Conditions: Required/applicable security standard uses this header.  Internal to ADP'
        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: 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
        required: true
      - 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
          - 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: SORUri
        description: Actual Uri within the SOR
        x-adpParameterData:
          visibilityCodes:
          - internal
        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: 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: 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: 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: 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: 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: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      tags:
      - Change Pay Distribution
  /payroll/v2/workers/{aoid}/pay-distributions/{pay-distribution-id}:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: payDistributionManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Pay Distributions
    get:
      summary: Pay Distribution
      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:
        - MobileMSSPayDistribution
        - MobilePSSPayDistribution
        - MobileESSPayDistribution
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/payDistributionManagement/worker.payDistribution.read
        operationCode: worker.payDistribution.read
        operationId: 555388d7-3bad-47b8-be4e-21aab1d429fa
        performAuthIndicator: true
        roleCodes:
        - manager
        - practitioner
        - employee
        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
                - 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
                - external
              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
            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
                - external
              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 a pay distribution
          content:
            application/json:
              schema:
                $ref: ./schemas/payDistributions_schema_v02_00_rev009.json
        '400':
          $ref: '#/components/responses/400'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        '413':
          $ref: '#/components/responses/413'
        '304':
          $ref: '#/components/responses/304'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: '<p style=''box-sizing: border-box; margin: 0px; font-size: 16px; font-weight: 300; line-height: 1.5; color:
        rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-style: normal; font-variant-ligatures: normal; font-variant-caps:
        normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space:
        normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style:
        initial; text-decoration-color: initial;''>Returns Direct Deposits based on the <strong style="box-sizing: border-box;
        font-weight: 600;">pay-distribution-id</strong>.<br style="box-sizing: border-box;"><strong style="box-sizing: border-box;
        font-weight: 600;">Tip:</strong> When an associate has more than one position, each position has a unique&nbsp;<strong
        style="box-sizing: border-box; font-weight: 600;">payrollGroupCode</strong> and&nbsp;<strong style="box-sizing: border-box;
        font-weight: 600;">payrollFileNumber</strong>. The user can retrieve all the Direct Deposits of company codes for
        all positions using GET <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing:
        border-box; background-color: transparent; color: rgb(74, 144, 226); text-decoration: none;">/payroll/v2/workers/{aoid}/pay-distributions</a>.</p><p
        style=''box-sizing: border-box; margin: 0px; font-size: 16px; font-weight: 300; line-height: 1.5; color: rgb(34, 34,
        34); font-family: TaubSans, "sans-serif"; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal;
        letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal;
        widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style:
        initial; text-decoration-color: initial;''>If the user wants to retrieve Direct Deposits of only one position, the
        user can make use of the GET <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing:
        border-box; background-color: transparent; color: rgb(74, 144, 226); text-decoration: none;">/payroll/v2/workers/{aoid}</a>
        <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing: border-box; background-color:
        transparent; color: rgb(74, 144, 226); text-decoration: none;">/pay-distributions/{pay-distribution-id}</a>. The API
        is called by passing the <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing:
        border-box; background-color: transparent; color: rgb(74, 144, 226); text-decoration: none;">{pay-distribution-id}</a>
        of the particular position. The <strong style="box-sizing: border-box; font-weight: 600;">{pay-distribution-id}</strong>
        value is obtained from the GET <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing:
        border-box; background-color: transparent; color: rgb(74, 144, 226); text-decoration: none;">/payroll/v2/workers</a>
        <a href="https://developers.adp.com/articles/api/pay-distributions-v2-api" style="box-sizing: border-box; background-color:
        transparent; color: rgb(74, 144, 226); text-decoration: none;">/{aoid}/pay-distributions</a> call.</p><p style=''box-sizing:
        border-box; margin: 0px; font-size: 16px; font-weight: 300; line-height: 1.5; color: rgb(34, 34, 34); font-family:
        TaubSans, "sans-serif"; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing:
        normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing:
        0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
        initial;''><br></p><p style=''box-sizing: border-box; margin: 0px 0px 10px; font-size: 16px; font-weight: 300; line-height:
        1.5; color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-style: normal; font-variant-ligatures: normal;
        font-variant-caps: normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform:
        none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255,
        255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;''>To
        address privacy concerns, clients can configure if to allow a user access bank account number and routing numbers.
        As part of your client onboarding process, you need to make sure clients confirm security settings for your connector
        user security profile by following the steps in <a href="https://developers.adp.com/articles/preview/guide-direct-deposit-api-guide-for-adp-workforce-now-0?chapter=7"
        style="box-sizing: border-box; background-color: transparent; color: rgb(74, 144, 226); text-decoration: none;">Appendix:
        Update the Security Profile to Retrieve Unmasked Bank Routing Numbers and Account Numbers</a>. By default,&nbsp;<strong
        style="box-sizing: border-box; font-weight: 600;">Account Number</strong> and&nbsp;<strong style="box-sizing: border-box;
        font-weight: 600;">Routing Numbe</strong>r are masked in the Direct Deposit API response. To reveal masked data, simply
        add the following header to your HTTP request:</p><p style=''box-sizing: border-box; margin: 0px 0px 10px; font-size:
        16px; font-weight: 300; line-height: 1.5; color: rgb(34, 34, 34); font-family: TaubSans, "sans-serif"; font-style:
        normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; orphans: 2; text-align:
        start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width:
        0px; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color:
        initial;''><strong style="box-sizing: border-box; font-weight: 600;">Accept:application/json;masked=false</strong></p>'
      operationId: 555388d7-3bad-47b8-be4e-21aab1d429fa
      parameters:
      - 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: query
        name: $select
        description: The OData $select parameter MUST be used to specify the selection criterion
        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: G4O73G9Z62SL2NFM
          type: string
        in: path
        name: aoid
        description: Associate OID
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - 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: ''
          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
        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
      - 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: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        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: CONSUMERAOID
        description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming
          the Web API.  Conditions: Required/applicable security standard uses this header. Internal to ADP'
        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_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
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: CONSUMEROOID
        description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer
          application belongs.  Conditions: Required/applicable security standard uses this header.  Internal to ADP'
        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: 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
        required: true
      - schema:
          default: ''
          type: string
        in: query
        name: asOfDate
        description: current date or selected date to see benefit election history of a participant as of date
        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
          - 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: SORUri
        description: Actual Uri within the SOR
        x-adpParameterData:
          visibilityCodes:
          - internal
        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: 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: PD00001-99M001130
          type: string
        in: path
        name: pay-distribution-id
        description: Pay Distribution ID
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        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: 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: 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: 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: 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
      tags:
      - Pay Distributions
components:
  responses:
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '204':
      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
            - 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
            - external
          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
        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
            - external
          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: No Content
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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
    '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
            - 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
            - external
          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
        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
            - external
          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