openapi: 3.2.0 info: contact: name: Banu Priya Chittoor email: banupriya.chittoor@adp.com description: This API is used to convey the output of a payroll run title: Payroll Outputs API version: 2.0.3 x-apievangelist-source: https://api-library-marketplace.adp.com/pr-offrg-auto.pay/payroll/payroll-outputs/v2/payroll-outputs-swagger_v2-merged.json x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn) x-apievangelist-resource-path: payroll/payroll-outputs/v2/payroll-outputs servers: - url: https://api.adp.com description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens' - url: https://api.eu.adp.com description: ADP European API gateway - url: https://uat-api.adp.com description: ADP UAT / sandbox gateway tags: - name: Payroll Outputs description: Worker payroll outputs - complete details paths: /payroll/v2/payroll-output/{output-id}: x-adpPathData: uriTranslationIndicator: false featureCode: payrollProcessingResults functionCode: payrollOutputManagement serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Payroll Outputs get: summary: Payroll Output Details x-adpOperationData: operationStateCode: active grantTypes: - client_credential asaFeatureCodes: - MobilePSSPayrollProcessingResults sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: payroll/payrollManagement/payrollProcessingResults/payrollOutputManagement/payrollOutput.read operationCode: payrollOutput.read operationId: e228fbee-847b-4704-aa65-ae01b69f21e2 performAuthIndicator: true roleCodes: - practitioner 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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 payroll output details content: application/json: schema: $ref: ./schemas/payrollOutputs_schema_v02_00_rev001.json '400': $ref: '#/components/responses/400' '412': $ref: '#/components/responses/412' '500': $ref: '#/components/responses/500' '401': $ref: '#/components/responses/401' '413': $ref: '#/components/responses/413' '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' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Returns payroll output details operationId: e228fbee-847b-4704-aa65-ae01b69f21e2 parameters: - 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-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: query name: $filter description: The OData $filter parameter is used to limit the payroll outputs returned. 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: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: 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: SORUri description: Actual Uri within the SOR 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: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: boolean in: query name: $count description: "Use the OData $count parameter to specify that the response should return the total number of instance resources \n\nEx. $count=true" x-adpParameterData: visibilityCodes: - internal - external 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: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $skip description: The OData $skip parameter MUST be used to specify the start sequence 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: 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 enum: - payroll - ' pay' - ' details' - ' acc' - ' acc-all' - ' acc-unpaid' - ' error' - ' dropped-pays' in: query name: level description: The payroll output level determines the data to be returned based on the country provided in the ADP-Context-ExpressionID header and the $top, $skip and $filter parameter values. x-adpParameterData: visibilityCodes: - internal - external 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 - external required: false - schema: default: '' type: string in: query name: $top description: The OData $top parameter MUST be used to specify the maximum number 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: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-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: '12345678' type: string in: path name: output-id description: Payroll Output ID 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: 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: 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-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: 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: 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-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: ADPX-RegionCode description: A service provider defined and set by the client identifier needed to properly route incoming requests to the appropriate instance serving the given region x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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 tags: - Payroll Outputs /payroll/v2/payroll-output: x-adpPathData: uriTranslationIndicator: false featureCode: payrollProcessingResults functionCode: payrollOutputManagement serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Payroll Outputs get: summary: Payroll Outputs x-adpOperationData: operationStateCode: active grantTypes: - client_credential asaFeatureCodes: - MobilePSSPayrollProcessingResults sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 canonicalUri: payroll/payrollManagement/payrollProcessingResults/payrollOutputManagement/payrollOutput.read operationCode: payrollOutput.read operationId: a4be6d02-ebe9-4c20-bc34-f80631735607 performAuthIndicator: true roleCodes: - practitioner scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: 12. Sample filter 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?level=pay&$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== and associatePayments/associateOID eq G304N3G1H9YE71W1' content: application/json: externalValue: ./examples/12._Sample_filter_Custom_Example_payrollOutput.read_200_602248.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: Scenario 2 responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: Request the list of all available payroll outputs that the requester is authorized to view content: application/json: externalValue: ./examples/Scenario_2_response_payrollOutput.read_200_442695.json description: New description scenario for the consumer of this API to better understand this example. parameters: $filter: itemID eq '{encoded_payrollOutputs/itemID}' - summary: New description scenario for the consumer of this API to better understand this example. name: 11. Default level filter - payrollRunNumber 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/payrollRunNumber eq 1' content: application/json: externalValue: ./examples/11._Default_level_filter_-_payrollRunNumber_Custom_Example_payrollOutput.read_200_602246.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 5. Default level filter - payrollRegionCode 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 the list of all available payroll outputs that the requester is authorized to view /payroll/v2/payroll-output?level=default&$filter=payrollRegionCode/codeValue eq RATE' content: application/json: externalValue: ./examples/5._Default_level_filter_-_payrollRegionCode_Custom_Example_payrollOutput.read_200_602236.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 13. Payroll level filter 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=payroll' content: application/json: externalValue: ./examples/13._Payroll_level_filter_Custom_Example_payrollOutput.read_200_602249.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 19. Calling Historical Data (Payroll Data older than 60 days) responses: - code: '202' description: 'At time of request, a 200 response will be sent with a 202 in the "confirm message" with the messageTxt of "INFO: All requests for payrolls greater than 60 days will be processed during non-business hours(i.e. after 6 p.m. local time)." in the userMessage node.' content: application/json: externalValue: ./examples/19._Calling_Historical_Data_(Payroll_Data_older_than_60_days)_Custom_Example_payrollOutput.read_202_602338.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 8. Default level filter - payrollProcessingJobID responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: "Request the list of all available payroll outputs that the requester is authorized to view\n\nAPI:\t\n/payroll/v2/payroll-output?level=default&$filter=payrollProcessingJobID eq EFE2D448-23F8-101B-8B39-FFD9C1E3C5FF" content: application/json: externalValue: ./examples/8._Default_level_filter_-_payrollProcessingJobID_Custom_Example_payrollOutput.read_200_602239.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 15. Details level filter 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=details' content: application/json: externalValue: ./examples/15._Details_level_filter_Custom_Example_payrollOutput.read_200_602251.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 7. Default level filter responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: 'Request the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow==&level=default' content: application/json: externalValue: ./examples/7._Default_level_filter_Custom_Example_payrollOutput.read_200_602238.json description: New description scenario for the consumer of this API to better understand this example. - summary: The Turbo API provides information related to a client's payrolls. This use case gets the details of a payroll. name: 3. Retrieving all the details of the payroll 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 the list of all available payroll outputs that the requester is authorized to view content: application/json: externalValue: ./examples/3._Retrieving_all_the_details_of_the_payroll_Custom_Example_payrollOutput.read_200_602226.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 the list of all available payroll outputs that the requester is authorized to view content: application/json: externalValue: ./examples/3._Retrieving_all_the_details_of_the_payroll_Custom_Example_payrollOutput.read_200_602167.json description: The Turbo API provides information related to a client's payrolls. This use case gets the details of a payroll. - summary: New description scenario for the consumer of this API to better understand this example. name: 9. Default level filter - scheduleEntryID 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/scheduleEntryID eq 20210115121728-1Vr2lkGlh7PqURciiwjuBF9zvVjchg7l9tUeUSjiLCg=' content: application/json: externalValue: ./examples/9._Default_level_filter_-_scheduleEntryID_Custom_Example_payrollOutput.read_200_602240.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: Scenario 1 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 the list of all available payroll outputs that the requester is authorized to view content: application/json: externalValue: ./examples/Scenario_1_Provide_Example_payrollOutput.read_200_44651.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 14. Pay level filter 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=pay' content: application/json: externalValue: ./examples/14._Pay_level_filter_Custom_Example_payrollOutput.read_200_602250.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 17. Acc level filter 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 the list of all available payroll outputs that the requester is authorized to view\n\nAPI: \n/payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=acc" content: application/json: externalValue: ./examples/17._Acc_level_filter_Custom_Example_payrollOutput.read_200_602253.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 10. Default level filter - PayrollYear 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 the list of all available payroll outputs that the requester is authorized to view\n\nAPI: \n/payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/payrollYear eq 2021" content: application/json: externalValue: ./examples/10._Default_level_filter_-_PayrollYear_Custom_Example_payrollOutput.read_200_602243.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 18. Acc - all level filter 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 the list of all available payroll outputs that the requester is authorized to view /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=acc-all' content: application/json: externalValue: ./examples/18._Acc_-_all_level_filter_Custom_Example_payrollOutput.read_200_602254.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 6. Default level filter - payroll week number responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: 'Request the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?level=default&$filter=payrollScheduleReference/payrollWeekNumber eq 03' content: application/json: externalValue: ./examples/6._Default_level_filter_-_payroll_week_number_Custom_Example_payrollOutput.read_200_602237.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 16. Pay Details level filter 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 the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?$filter=itemID eq 47yN-7cwtRB6AsQDOHgAow== &level=payDetails' content: application/json: externalValue: ./examples/16._Pay_Details_level_filter_Custom_Example_payrollOutput.read_200_602252.json description: New description scenario for the consumer of this API to better understand this example. - summary: New description scenario for the consumer of this API to better understand this example. name: 4. Default level filter - Payroll Group code responses: - headers: ADP-Acting-Session-Expires: '' Cache-Control: '' sm_transactionid: '' ETag: '' ADP-Acting-SessionID: '' Content-Type: '' code: '200' description: 'Request the list of all available payroll outputs that the requester is authorized to view API: /payroll/v2/payroll-output?level=default&$filter=payrollGroupCode/codeValue eq {{payrollGroupCode}}' content: application/json: externalValue: ./examples/4._Default_level_filter_-_Payroll_Group_code_Custom_Example_payrollOutput.read_200_602235.json description: New description scenario for the consumer of this API to better understand this example. 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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 the list of all available payroll outputs that the requester is authorized to view content: application/json: schema: $ref: ./schemas/payrollOutputs_schema_v02_00_rev001.json '400': $ref: '#/components/responses/400' '202': $ref: '#/components/responses/202' '500': $ref: '#/components/responses/500' '412': $ref: '#/components/responses/412' '401': $ref: '#/components/responses/401' '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' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Returns complete payroll output details that the requester is authorized to view based on the supplied filter criteria operationId: a4be6d02-ebe9-4c20-bc34-f80631735607 parameters: - 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-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: query name: $filter description: The OData $filter parameter is used to limit the payroll outputs returned. 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: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: 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: SORUri description: Actual Uri within the SOR 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: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: boolean in: query name: $count description: "Use the OData $count parameter to specify that the response should return the total number of instance resources \n\nEx. $count=true" x-adpParameterData: visibilityCodes: - internal - external 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: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $skip description: The OData $skip parameter MUST be used to specify the start sequence 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: 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: query name: $select description: The OData $select parameter MUST be used to specify the selection criterion x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: query name: $top description: The OData $top parameter MUST be used to specify the maximum number 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: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal 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: 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: 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-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: 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: 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: ADPX-RegionCode description: A service provider defined and set by the client identifier needed to properly route incoming requests to the appropriate instance serving the given region x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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 tags: - Payroll Outputs /payroll/v2/employment-verification/payroll-output: x-adpPathData: uriTranslationIndicator: false featureCode: payrollProcessingResults functionCode: employmentVerificationManagement serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Payroll Outputs get: summary: Payroll Outputs x-adpOperationData: asaFeatureCodes: - MobilePSSPayrollEmploymentVerification canonicalUri: payroll/payrollManagement/payrollProcessingResults/employmentVerificationManagement/payrollOutput.read operationCode: payrollOutput.read roleCodes: - practitioner scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: 1. Retrieving payroll output for an Equifax Canada client. responses: - code: '200' description: 'Request the list of all available payroll outputs that the requester is authorized to view. This Uniform Resource Identifier (URI) is for an Equifax Canada client.' content: application/json: externalValue: ./examples/1._Retrieving_payroll_output_for_an_Equifax_Canada_client._Custom_Example_payrollOutput.read_200_602168.json description: New description scenario for the consumer of this API to better understand this example. globalViewDevPortalIndicator: true operationStateCode: active grantTypes: - client_credential sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationDataAttributeSensitivitylevels: - dataSensitivityCategory: NA attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/UPIC dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/BBAN dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/IBAN dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/associatePayments/payments/paymentDistributions/directDeposits/depositAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/thirdPartyPayments/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/statutoryDeductionsSummary/statutoryDeductionsSummarySections/statutoryDeductionsSummaryItems/impoundInformation/impoundAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/fatherName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/checkImpoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reimbursementsSummary/reimbursementsSummarySections/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payrollOutputs/payrollSummary/reportableEarningsAndBenefitsSummary/reportableEarningsAndBenefitsSummarySections/impoundInformation/impoundAccount dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/earningsSummary/earningsSummarySections/impoundInformation/impoundAccount/familyName2 dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/paymentDistributionsSummary/depositImpoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payrollOutputs/payrollSummary/nonStatutoryDeductionsSummary/nonStatutoryDeductionSummarySections/impoundInformation/impoundAccount/formattedNames dataSensitivityLevelCode: 2 operationId: 9780791c-1df6-4665-97f6-69d868597f74 performAuthIndicator: true dataSensitivityLevelCode: 3 visibilityCodes: - internal - external responses: '200': headers: 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 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 description: Request the list of all available payroll outputs that the requester is authorized to view content: application/json: schema: $ref: ./schemas/payrollOutputs_schema_v02_00_rev001.json '400': $ref: '#/components/responses/400' '412': $ref: '#/components/responses/412' '401': $ref: '#/components/responses/401' '500': $ref: '#/components/responses/500' '413': $ref: '#/components/responses/413' '403': $ref: '#/components/responses/403' '304': $ref: '#/components/responses/304' '404': $ref: '#/components/responses/404' '503': $ref: '#/components/responses/503' '504': $ref: '#/components/responses/504' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' description: Returns complete payroll output details that the requester is authorized to view based on the supplied filter criteria operationId: 9780791c-1df6-4665-97f6-69d868597f74 parameters: - 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-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: query name: $filter description: The OData $filter parameter is used to limit the payroll outputs returned. 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: sm_userdn description: 'SiteMinder user LDAP distinguished name. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: 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: SORUri description: Actual Uri within the SOR 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: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - 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: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: query name: $skip description: The OData $skip parameter MUST be used to specify the start sequence 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: 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: query name: $top description: The OData $top parameter MUST be used to specify the maximum number 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: sm_user description: 'SiteMinder user ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal 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: 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-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: 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-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: ADPX-RegionCode description: A service provider defined and set by the client identifier needed to properly route incoming requests to the appropriate instance serving the given region x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-AssociateOID description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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 tags: - Payroll Outputs /payroll/v1/payroll-outputs: get: operationId: listPayrollOutputs summary: List Payroll Outputs description: Retrieve payroll output summaries for completed payroll runs including totals, period dates, and status. tags: - Payroll Outputs parameters: - name: $filter in: query description: OData filter expression schema: type: string example: example_value - name: $top in: query schema: type: integer default: 25 example: 10 - name: $skip in: query schema: type: integer default: 0 example: 10 responses: '200': description: List of payroll outputs content: application/json: schema: $ref: '#/components/schemas/PayrollOutputsResponse' examples: Listpayrolloutputs200Example: summary: Default listPayrollOutputs 200 response x-microcks-default: true value: payrollOutputs: - payrollOutputID: '500123' payrollScheduleReference: {} payrollStatusCode: {} workerCount: 10 meta: totalCount: 10 '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /payroll/v1/payroll-outputs/{payrollOutputID}: get: operationId: getPayrollOutput summary: Get Payroll Output Details description: Retrieve full payroll output details for a specific payroll run by output ID. tags: - Payroll Outputs parameters: - name: payrollOutputID in: path required: true schema: type: string example: '500123' responses: '200': description: Payroll output details content: application/json: schema: $ref: '#/components/schemas/PayrollOutputResponse' examples: Getpayrolloutput200Example: summary: Default getPayrollOutput 200 response x-microcks-default: true value: payrollOutputs: - payrollOutputID: '500123' payrollScheduleReference: {} payrollSummary: {} '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /payroll/v1/payroll-outputs/{payrollOutputID}/worker-outputs: get: operationId: getPayrollWorkerOutputs summary: Get Worker-level Payroll Outputs description: Retrieve individual worker pay statement data for a specific payroll run. tags: - Payroll Outputs parameters: - name: payrollOutputID in: path required: true schema: type: string example: '500123' - name: $top in: query schema: type: integer default: 100 example: 10 - name: $skip in: query schema: type: integer default: 0 example: 10 responses: '200': description: Worker payroll outputs content: application/json: schema: $ref: '#/components/schemas/WorkerOutputsResponse' examples: Getpayrollworkeroutputs200Example: summary: Default getPayrollWorkerOutputs 200 response x-microcks-default: true value: payrollOutputs: - payrollOutputID: '500123' workerOutputs: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK components: responses: '429': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal - 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 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 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '202': description: Accepted content: application/json: {} '401': description: Unauthorized content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '405': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal - 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 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 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '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 Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - 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 '504': description: Gateway Timeout content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '413': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal - 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 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 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 Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' NotFound: description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' schemas: PayrollOutputSummary: type: object properties: payrollOutputID: type: string example: '500123' payrollScheduleReference: type: object properties: payFrequencyCode: type: object properties: codeValue: type: string enum: - Weekly - BiWeekly - SemiMonthly - Monthly payPeriodStartDate: type: string format: date payPeriodEndDate: type: string format: date payDate: type: string format: date example: example_value payrollStatusCode: type: object properties: codeValue: type: string enum: - Open - Closed - Processing - Completed - Locked example: example_value workerCount: type: integer example: 10 PayrollOutputsResponse: type: object properties: payrollOutputs: type: array items: $ref: '#/components/schemas/PayrollOutputSummary' example: [] meta: type: object properties: totalCount: type: integer example: example_value TaxItem: type: object properties: typeCode: type: object properties: codeValue: type: string example: example_value nameCode: type: object properties: codeValue: type: string example: example_value amount: $ref: '#/components/schemas/AmountValue' jurisdictionCode: type: object properties: codeValue: type: string example: example_value EarningItem: type: object properties: typeCode: type: object properties: codeValue: type: string example: example_value nameCode: type: object properties: codeValue: type: string shortName: type: string example: example_value amount: $ref: '#/components/schemas/AmountValue' hoursQuantity: type: number example: 42.5 rateAmount: $ref: '#/components/schemas/AmountValue' AmountValue: type: object properties: amountValue: type: number format: double example: 42.5 currencyCode: type: string default: USD example: example_value PayrollOutput: type: object properties: payrollOutputID: type: string example: '500123' payrollScheduleReference: type: object properties: payFrequencyCode: type: object properties: codeValue: type: string payPeriodStartDate: type: string format: date payPeriodEndDate: type: string format: date payDate: type: string format: date example: example_value payrollSummary: type: object properties: grossPayAmount: $ref: '#/components/schemas/AmountValue' netPayAmount: $ref: '#/components/schemas/AmountValue' totalDeductionsAmount: $ref: '#/components/schemas/AmountValue' totalTaxesAmount: $ref: '#/components/schemas/AmountValue' example: example_value DeductionItem: type: object properties: typeCode: type: object properties: codeValue: type: string example: example_value nameCode: type: object properties: codeValue: type: string shortName: type: string example: example_value amount: $ref: '#/components/schemas/AmountValue' WorkerPayOutput: type: object properties: associateOID: type: string example: '500123' workerID: type: object properties: idValue: type: string example: '500123' payStatementID: type: string example: '500123' payDate: type: string format: date example: '2026-01-15' grossPayAmount: $ref: '#/components/schemas/AmountValue' netPayAmount: $ref: '#/components/schemas/AmountValue' regularEarnings: type: array items: $ref: '#/components/schemas/EarningItem' example: [] overtimeEarnings: type: array items: $ref: '#/components/schemas/EarningItem' example: [] otherEarnings: type: array items: $ref: '#/components/schemas/EarningItem' example: [] deductions: type: array items: $ref: '#/components/schemas/DeductionItem' example: [] taxes: type: array items: $ref: '#/components/schemas/TaxItem' example: [] ErrorMessage: type: object properties: confirmMessage: type: object properties: processMessages: type: array items: type: object properties: messageTypeCode: type: object properties: codeValue: type: string userMessage: type: object properties: messageTxt: type: string example: example_value WorkerOutputsResponse: type: object properties: payrollOutputs: type: array items: type: object properties: payrollOutputID: type: string workerOutputs: type: array items: $ref: '#/components/schemas/WorkerPayOutput' example: [] PayrollOutputResponse: type: object properties: payrollOutputs: type: array maxItems: 1 items: $ref: '#/components/schemas/PayrollOutput' example: [] securitySchemes: oauth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: https://accounts.adp.com/auth/oauth/v2/token scopes: api__payroll-output-v1__read: Read payroll output data x-adpSpecData: domain: Payroll specId: cb970e42-dab5-4457-8c4c-6bf1ce29505d canonicalSpecId: 769eeb51-16fc-4556-ab32-cb5c6ddbe34f specStatusCode: publishing specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: payroll-outputs-swagger_v2-merged.json serviceProviderId: 'null' resourcePath: payroll/payroll-outputs/v2 libraryVersion: '' businessRules: - rule: R6.1 ruleTitle: An event instance which is being “worked on” has an event.status.code=inprogress visibilityCodes: - internal - rule: R8.1 ruleTitle: An event notification includes the /data/eventContext and /data/output objects. 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: R6.2 ruleTitle: An event instance which has been recorded has an event.status.code=complete 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: 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: 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: R2.1 ruleTitle: If the event is declared by an actor then the creationDateTime is the date time when the first call is made to the System of Record. visibilityCodes: - internal - rule: R3.3 ruleTitle: /data/output communicates the result of the event instance. visibilityCodes: - internal - rule: R3.4 ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results. 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: 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: R0.3 ruleTitle: 'For Act-As or On-Behalf-Of requests, header ''Cache-Control: no-store'' MUST be set to indicate on server or on UI the response object SHOULD not be cached' visibilityCodes: - internal - rule: R8.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: 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: 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.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: 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: 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: R3.5 ruleTitle: A complete event has /data/eventContext and /data/output visibilityCodes: - internal - rule: R8.2 ruleTitle: An event notification does not include the transform or meta objects. visibilityCodes: - internal - rule: R2.3 ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective 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: R1.0 ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete 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: 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 eventNotifications: - eventCode: payrollJobStatus.change.eventNotify.subscribe example: href: payroll-processing-job-status-change_payroll_complete_EvenNotification.json testCaseCollection: example: href: PayrollOutputs.postman_collection.json description: Payroll Outputs postman collection publicationContext: products: - productId: hcm-offrg-wfn.next.gen productName: workforce now next generation marketplaceProductName: ADP Workforce Now® Next Generation - productId: hcm-offrg-ent productName: enterprise marketplaceProductName: ADP Enterprise HR® - productId: hcm-offrg-vantg productName: vantage marketplaceProductName: ADP® Vantage HCM - productId: hcm-offrg-wfn productName: workforce now marketplaceProductName: ADP Workforce Now® - productId: hcm-offrg-lifion productName: lifion marketplaceProductName: ADP Lyric specCategoryCode: ''