openapi: 3.0.1 servers: - url: https://api.adp.com description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens' - url: https://api.eu.adp.com description: ADP European API gateway - url: https://uat-api.adp.com description: ADP UAT / sandbox gateway info: contact: name: Donald Vargo email: donny.vargo@adp.com description: A Pay Statement describes the details of a payment made to a payee. These details include the net and gross payment amounts, deductions, earnings, and year-to-date payroll accuals. The Pay Statements APIs can be used to retrieve the list of a specified number of pay statements for an associate or to get details for a specific statement. title: Pay Statements version: 1.0.27 x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/payroll/pay-statements/v1/pay-statements-swagger_v1-merged.json x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn) x-apievangelist-resource-path: payroll/pay-statements/v1/pay-statements x-adpSpecData: domain: Payroll specId: 4eaad21f-c9a7-47a7-97a6-43c25ad1b23b canonicalSpecId: 54610620-5bf4-418a-b718-2af9d6198139 specStatusCode: publishing specTypeCode: REST specStateCode: active nonStandardIndicator: false visibilityCodes: - internal - external filename: pay-statements-swagger_v1-merged.json serviceProviderId: 'null' resourcePath: payroll/pay-statements/v1 libraryVersion: '' businessRules: - 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: 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: 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: R11.1 ruleTitle: '''associateoid'' in the uri pattern should match the ''associateoid'' in the request header parameter' visibilityCodes: - internal - rule: R2.2 ruleTitle: The recordDateTime is the date time which the event is recorded in the system of record with an event.status.code=complete visibilityCodes: - internal - rule: R3.2 ruleTitle: /data/transform is only used during the recording of the event. The transform is the data that is provided by a user/machine to complete the recording of the event. visibilityCodes: - internal - rule: R3.5 ruleTitle: A complete event has /data/eventContext and /data/output visibilityCodes: - internal - rule: R3.1 ruleTitle: /data/input is optional. Input communicates data that is needed to complete recording the event instance. An example is a benefits.enroll event. The input communicates the benefitOfferings (the choices) that the user has to make which are communicated in the transform. visibilityCodes: - internal - rule: R0.3 ruleTitle: 'For Act-As or On-Behalf-Of requests, header ''Cache-Control: no-store'' MUST be set to indicate on server or on UI the response object SHOULD not be cached' visibilityCodes: - internal - rule: R2.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: 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: R8.2 ruleTitle: An event notification does not include the transform or meta objects. 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: R8.1 ruleTitle: An event notification includes the /data/eventContext and /data/output objects. visibilityCodes: - internal - rule: R3.4 ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results. 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: R1.0 ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete visibilityCodes: - internal - rule: R11.0 ruleTitle: To request the set of requested statement images as one zipped file the Accept header should be set to Accept=application/gzip 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.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.3 ruleTitle: /data/output communicates the result of the event instance. visibilityCodes: - internal - rule: R5.0 ruleTitle: Meta returns the context rules for each data section visibilityCodes: - internal - rule: R6.2 ruleTitle: An event instance which has been recorded has an event.status.code=complete 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: R13.1 ruleTitle: The resourceSetID is a unique identifier related to this request with the set of payStatementDetails requested. visibilityCodes: - internal - rule: R13.0 ruleTitle: 'The output/links should contain the uri of the images or the gzip.''links'': [{''rel'':''enclosure'',''href'':''/payroll/v1/workers/{aoid}/pay-statement/images?resourceSetID=1232345'',''method'':''GET''}]' 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: R6.1 ruleTitle: An event instance which is being 'worked on' has an event.status.code=inprogress visibilityCodes: - internal - rule: R14.0 ruleTitle: To request a set of images that are not zipped into one file then the Accept header is not passed. The request will return the output/links[] with the set of uris to be called. 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: R12.1 ruleTitle: The payDetailUri value will be the relative uri of the image. visibilityCodes: - internal testCaseCollection: example: href: Pay_Statements.postman_collection.json description: Pay Statements publicationContext: products: - productId: hcm-offrg-wfn.next.gen productName: workforce now next generation marketplaceProductName: ADP Workforce Now® Next Generation - productId: ta-offrg-wfm productName: ADP® Workforce Manager marketplaceProductName: ADP® Workforce Manager specCategoryCode: '' tags: - name: Pay Statements description: List worker pay statements paths: /payroll/v1/workers/{aoid}/organizational-pay-statements/{pay-statement-id}/images/{image-id}.{image-extension}: x-adpPathData: uriTranslationIndicator: false featureCode: organizationPayStatementManagement functionCode: payStatementViewing serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Pay Statements get: summary: Client Specific Pay Statement Image x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobilePSSOrgPayStatements - MobileESSOrgPayStatements canonicalUri: payroll/payrollManagement/organizationPayStatementManagement/payStatementViewing/payStatement.read sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationCode: payStatement.read operationId: 5f32da43-e14c-4690-b147-359ed5d5ef9b roleCodes: - practitioner - employee performAuthIndicator: true scenarios: - summary: Request the details of a single client-specific pay statement as an image name: Request the details of a single client-specific pay statement as an image responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset ETag: unset sm_transactionid: unset Content-Language: unset ADP-Acting-SessionID: unset Content-Type: unset code: '200' description: Request the details of a single client-specific pay statement as a PDF image. content: application/pdf: externalValue: ./examples/Request_the_details_of_a_single_client-specific_pay_statement_as_an_image_Generate_from_Schema_payStatement.read_200_498584.json description: Request the details of a single client-specific pay statement as an image 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 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 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 Content-Language: schema: type: string description: Specifies the languages for which the entity-body is intended 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 details of a single client-specific pay statement as an image content: application/pdf: {} image/*: {} '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '412': $ref: '#/components/responses/412' '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' '405': $ref: '#/components/responses/405' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' operationId: 5f32da43-e14c-4690-b147-359ed5d5ef9b description: Request the details of a single client-specific pay statement as an image parameters: - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: Accept description: 'Accept'' '': '' ( ''*/*'' | (type''/'' ''*'') | (type''/''subtype)) [''; '' ''q'' ''=''qvalue]. Describes media type(s) and subtype(s) that are acceptable for the response. The optional qvalue represents an acceptable quality level for acceptable types.' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: 2e30612a-1a5b-4b85-abcc-da50f0a2ae5f type: string in: query name: ADP-Acting-SessionID description: ADP Acting Session ID x-adpParameterData: visibilityCodes: - internal - external required: true - 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: path name: aoid description: Associate OID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '321354' type: string in: path name: pay-statement-id description: Pay statement ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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: jpeg type: string in: path name: image-extension description: Pay statement Image Extension x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: CONSUMERAOID description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming the Web API. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: en-US type: string in: header name: Accept-Language description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: statement type: string in: path name: image-id description: Pay statement Image ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' 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: 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: 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_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: CONSUMEROOID description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer application belongs. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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 tags: - Pay Statements /payroll/v1/workers/{aoid}/organizational-pay-statements/{pay-statement-id}: x-adpPathData: uriTranslationIndicator: false featureCode: organizationPayStatementManagement functionCode: payStatementViewing serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Pay Statement get: summary: Client Specific Pay Statement x-adpOperationData: asaFeatureCodes: - MobileESSOrgPayStatements - MobilePSSOrgPayStatements canonicalUri: payroll/payrollManagement/organizationPayStatementManagement/payStatementViewing/payStatement.read operationCode: payStatement.read roleCodes: - employee - practitioner scenarios: - summary: New description scenario for the consumer of this API to better understand this example. name: retrieve Pay Statement Details responses: - code: '200' description: Request the details of a single client-specific pay statement content: application/json: externalValue: ./examples/retrieve_Pay_Statement_Details_response_payStatement.read_200_601910.json description: New description scenario for the consumer of this API to better understand this example. globalViewDevPortalIndicator: true operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationDataAttributeSensitivitylevels: - dataSensitivityCategory: NA attributeName: /payStatement/payDistributions/distributions/depositAccount/financialParty/address dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payStatement/worker/taxIDs/parentRegistrationID dataSensitivityLevelCode: 3 - dataSensitivityCategory: financialInfo attributeName: /payStatement/payDistributions/distributions/depositAccount/UPIC dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payStatement/employer/taxIDs/parentRegistrationID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payStatement/payDistributions/distributions/depositAccount/financialAccount/contactName dataSensitivityLevelCode: 2 - dataSensitivityCategory: financialInfo attributeName: /payStatement/payDistributions/distributions/depositAccount/IBAN dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payStatement/payDistributions/distributions/depositAccount/financialParty/communication/emails dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payStatement/payDistributions/distributions/depositAccount/accountID dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payStatement/worker/workerName dataSensitivityLevelCode: 2 - dataSensitivityCategory: NA attributeName: /payStatement/worker/taxIDs dataSensitivityLevelCode: 3 - dataSensitivityCategory: financialInfo attributeName: /payStatement/payDistributions/distributions/depositAccount/BBAN dataSensitivityLevelCode: 3 - dataSensitivityCategory: NA attributeName: /payStatement/employer/taxIDs dataSensitivityLevelCode: 3 operationId: f4f4fd27-1035-42a0-b8eb-802667e6385b performAuthIndicator: true dataSensitivityLevelCode: 3 visibilityCodes: - internal - external responses: '200': description: Request the details of a single client-specific pay statement content: application/json: schema: $ref: ./schemas/payStatement_schema_v01_00_rev021.json '400': $ref: '#/components/responses/400' '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' '503': $ref: '#/components/responses/503' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' operationId: f4f4fd27-1035-42a0-b8eb-802667e6385b description: Request the details of a single client-specific pay statement parameters: - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' 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: path name: aoid description: Associate OID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '321354' type: string in: path name: pay-statement-id description: Pay statement ID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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: CONSUMERAOID description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming the Web API. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: en-US type: string in: header name: Accept-Language description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' 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: 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: 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_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: CONSUMEROOID description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer application belongs. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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 tags: - Pay Statements /payroll/v1/workers/{aoid}/organizational-pay-statements: x-adpPathData: uriTranslationIndicator: false featureCode: organizationPayStatementManagement functionCode: payStatementViewing serviceCode: payrollManagement serviceCategoryCode: payroll canonicalName: Pay Statements get: summary: Client Specific Pay Statements x-adpOperationData: operationStateCode: active grantTypes: - authorization_code - urn:ietf:params:oauth:grant-type:saml2-bearer - urn:ietf:params:oauth:grant-type:jwt-bearer - client_credential asaFeatureCodes: - MobilePSSOrgPayStatements - MobileESSOrgPayStatements canonicalUri: payroll/payrollManagement/organizationPayStatementManagement/payStatementViewing/payStatement.read sorRequestTimeoutPolicies: cachedTimeout: 3 notCachedTimeout: 10 operationCode: payStatement.read operationId: 880a38af-1ece-4606-b028-6d7d319e2ec9 roleCodes: - practitioner - employee performAuthIndicator: true scenarios: - summary: Request the list of the last n client-specific pay statements for an associate. name: Retrieve a list of pay statements for an associate. responses: - headers: ADP-Acting-Session-Expires: unset Cache-Control: unset ETag: unset sm_transactionid: unset ADP-Acting-SessionID: unset Content-Language: unset Content-Type: unset code: '200' description: Request the list of the last n client-specific pay statements for an associate. Default = pay statements from the last 5 pay dates. content: application/json: externalValue: ./examples/Retrieve_a_list_of_pay_statements_for_an_associate._Custom_Example_payStatement.read_200_498583.json description: Request the list of the last n client-specific pay statements for an associate. 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 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 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 Content-Language: schema: type: string description: Specifies the languages for which the entity-body is intended 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 the last n client-specific pay statements for an associate. Default = pay statements from the last 5 pay dates. content: application/json: schema: $ref: ./schemas/payStatements_schema_v01_00_rev012.json '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' '412': $ref: '#/components/responses/412' '401': $ref: '#/components/responses/401' '204': $ref: '#/components/responses/204' '413': $ref: '#/components/responses/413' '304': $ref: '#/components/responses/304' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '503': $ref: '#/components/responses/503' '405': $ref: '#/components/responses/405' '504': $ref: '#/components/responses/504' '406': $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' operationId: 880a38af-1ece-4606-b028-6d7d319e2ec9 description: Request the list of the last n client-specific pay statements for an associate. Default = pay statements from the last 5 pay dates. parameters: - schema: default: '' type: string in: header name: sm_auth_level description: 'SiteMinder autorization level. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: sm_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: employee type: string enum: - employee - ' manager' - ' practitioner' - ' administrator' - ' supervisor' in: header name: roleCode description: 'The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header should be passed in all calls.' x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: '' 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: If-None-Match description: Used with a method to make it conditional; the method is performed only if the client entity (via the given entity tag, ETag header) does not match the server entity. x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: path name: aoid description: Associate OID x-adpParameterData: visibilityCodes: - internal - external required: true - schema: default: ISI type: string in: header name: realm description: The identity management realm, e.g. ISI x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: ADP-On-Behalf-Of-OrgOID description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: associateoid description: Associate OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: '' type: string in: header name: sm_transactionid description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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: CONSUMERAOID description: 'CONSUMERAOID'' '': '' identifier. Contains the object identifier of the application that is consuming the Web API. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: SORContext description: Context within an SOR that the call should be routed to x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: orgoid description: Organization OID of the requestor as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: true - schema: default: en-US type: string in: header name: Accept-Language description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.' x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: SORUri description: Actual Uri within the SOR x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Act-As-OrgOID description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Context-ExpressionID description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: ADP-Consumer-ApplicationID description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' 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: 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: '26' type: integer in: query name: numberoflastpaydates description: Maximum pay statements which should be returned based on a request. x-adpParameterData: visibilityCodes: - internal - external 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_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: CONSUMEROOID description: 'CONSUMEROOID'' '': '' identifier. Contains the object identifier of the organization to which the consumer application belongs. Conditions: Required/applicable security standard uses this header. Internal to ADP' x-adpParameterData: visibilityCodes: - internal required: false - schema: default: '' type: string in: header name: Authorization description: Provides the client's authorization token to access the resource representation at a URI x-adpParameterData: visibilityCodes: - internal - external required: false - schema: default: '' type: string in: header name: 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 tags: - Pay Statements components: responses: '400': description: Bad Request content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '401': description: Unauthorized content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '412': description: Precondition Failed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '500': description: Internal Server Error content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '413': description: Request Entity Too Large content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '204': headers: ADP-Acting-Session-Expires: schema: type: string description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal - external required: false sm_transactionid: schema: type: string description: 'SiteMinder transaction ID. Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3' x-adpParameterData: visibilityCodes: - internal - external required: false Cache-Control: schema: type: string description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain. x-adpParameterData: visibilityCodes: - internal - external required: false ETag: schema: type: string description: Defines the entity tag for use with the If-Match and If-None-Match request headers. x-adpParameterData: visibilityCodes: - internal - external required: false ADP-Acting-SessionID: schema: type: string description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios x-adpParameterData: visibilityCodes: - internal - external required: false Content-Type: schema: type: string description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.' x-adpParameterData: visibilityCodes: - internal - external required: false description: No Content '403': description: Forbidden content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '304': description: Not Modified '404': description: Not Found content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '503': description: Service Unavailable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '405': description: Method Not Allowed content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '504': description: Gateway Timeout content: application/json: schema: $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json '406': description: Not Acceptable content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json '429': description: Too Many Requests content: application/json: schema: $ref: ../../../common/responses/v1/schemas/response_v1_0_schema_rev004_file.json