adp.workerpayrollinstructions
Module adp.workerpayrollinstructions
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_adp.workerpayrollinstructions_1.5.1.png)
ballerinax/adp.workerpayrollinstructions Ballerina library
Overview
This is a generated connector for ADP Worker Payroll Instructions API v1 OpenAPI specification. The ADP Worker Payroll Instructions API provides the capability to specify recurring general deductions, garnishments, and retirement plan deductions for a specified worker.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an ADP account.
- Obtain tokens - Follow this guide.
Clients![](/images/permalink.svg)
adp.workerpayrollinstructions: Client![](/images/permalink.svg)
Worker payroll instructions are used to specify recurring general deductions, garnishments, and retirement plan deductions for a specified worker. The Worker Payroll Instructions v1 APIs are used to start or stop payroll instructions for a worker, or to change an instruction that was previously started. You can also view all of the payroll instructions for a worker. API metadata is available.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an ADP account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
listPayrollInstructions![](/images/permalink.svg)
function listPayrollInstructions(string aoid, string roleCode) returns PayrollInstructions|error
Request the list of all available payroll instructions that the requester is authorized to view
Parameters
- aoid string - Associate OID
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
Return Type
- PayrollInstructions|error - Request the list of all available payroll outputs that the requester is authorized to view
startWorkerGeneralInstructionEvent![](/images/permalink.svg)
function startWorkerGeneralInstructionEvent(string roleCode, WorkerGeneralDeductionInstructionStartEvent payload) returns WorkerGeneralDeductionInstructionStartEvent|error
Start worker general deduction instruction information
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- payload WorkerGeneralDeductionInstructionStartEvent - Start event
Return Type
- WorkerGeneralDeductionInstructionStartEvent|error - Start event
getStartEventMetaData![](/images/permalink.svg)
function getStartEventMetaData(string roleCode, string? filter) returns WorkerGeneralDeductionInstructionStartEventMeta|error
Returns an event metadata
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- filter string? (default ()) - The OData $filter parameter MUST be used to specify the filter criteria. The usage sample is below. Various criteria could be combined using and/or operands and () to set the operand precedence. Please refer """"RESTful Web API Design Standard"""" for more details $filter=/mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM' $filter=/mobileUserAccounts/organizationOID eq 'ABCDEFGH' $filter=/mobileUserAccounts/accountStatusCode eq 'STATCODE' $filter=/mobileUserAccounts/personName/givenName eq 'John' $filter=/mobileUserAccounts/personName/familyName1 eq 'Smith' $filter=/mobileUserAccounts/birthDate eq '01-01-1970'
Return Type
- WorkerGeneralDeductionInstructionStartEventMeta|error - Return a payroll output details
changeWorkerGeneralInstructionEvent![](/images/permalink.svg)
function changeWorkerGeneralInstructionEvent(string roleCode, WorkerGeneralDeductionInstructionChangeEvent payload) returns WorkerGeneralDeductionInstructionChangeEvent|error
Change worker general deduction instruction information
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- payload WorkerGeneralDeductionInstructionChangeEvent - Change event
Return Type
- WorkerGeneralDeductionInstructionChangeEvent|error - Change event
getChangeEventMetaData![](/images/permalink.svg)
function getChangeEventMetaData(string roleCode, string? filter) returns WorkerGeneralDeductionInstructionChangeEventMeta|error
Returns an event metadata
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- filter string? (default ()) - The OData $filter parameter MUST be used to specify the filter criteria. The usage sample is below. Various criteria could be combined using and/or operands and () to set the operand precedence. Please refer """"RESTful Web API Design Standard"""" for more details $filter=/mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM' $filter=/mobileUserAccounts/organizationOID eq 'ABCDEFGH' $filter=/mobileUserAccounts/accountStatusCode eq 'STATCODE' $filter=/mobileUserAccounts/personName/givenName eq 'John' $filter=/mobileUserAccounts/personName/familyName1 eq 'Smith' $filter=/mobileUserAccounts/birthDate eq '01-01-1970'
Return Type
- WorkerGeneralDeductionInstructionChangeEventMeta|error - Returns a meta
stopWorkerGeneralInstructionEvent![](/images/permalink.svg)
function stopWorkerGeneralInstructionEvent(string roleCode, WorkerGeneralDeductionInstructionStopEvent payload) returns WorkerGeneralDeductionInstructionStopEvent|error
Stop worker general deduction instruction information
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- payload WorkerGeneralDeductionInstructionStopEvent - Stop event
Return Type
- WorkerGeneralDeductionInstructionStopEvent|error - Stop event
getStopEventMetaData![](/images/permalink.svg)
function getStopEventMetaData(string roleCode, string? filter) returns WorkerGeneralDeductionInstructionStopEventMeta|error
Returns an event metadata
Parameters
- roleCode string - The role the user is playing during the transaction. Possible values: employee,manager,practitioner,administrator,supervisor. The roleCode header will be passed in all calls. When coming from Myself capabilities rolecode=employee. When coming from Team capabilities roleCode=manager. When coming from Practitioner capabilities roleCode=practitioner.
- filter string? (default ()) - The OData $filter parameter MUST be used to specify the filter criteria. The usage sample is below. Various criteria could be combined using and/or operands and () to set the operand precedence. Please refer """"RESTful Web API Design Standard"""" for more details $filter=/mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM' $filter=/mobileUserAccounts/organizationOID eq 'ABCDEFGH' $filter=/mobileUserAccounts/accountStatusCode eq 'STATCODE' $filter=/mobileUserAccounts/personName/givenName eq 'John' $filter=/mobileUserAccounts/personName/familyName1 eq 'Smith' $filter=/mobileUserAccounts/birthDate eq '01-01-1970'
Return Type
- WorkerGeneralDeductionInstructionStopEventMeta|error - Event meta data
Records![](/images/permalink.svg)
adp.workerpayrollinstructions: ActiontypeV02![](/images/permalink.svg)
Actions which the user is allowed to initiate against the related entity
Fields
- operationID string? - Identifies the operation of an action
- canonicalUri UritypeV01? - The URI of the related entity
- actionTypeCode string? - Identifies the type of action to be taken to fulfill the request. Action can be a callback to a service to complete the action. A callback requires the methodCode and uris to be returned. An external link i.e. open a web page - requires the uris of the external link; An object reference is a reference to a related object within the application. This is a canonical name which represents the object. Based on this identifier, the application knows what view it needs to open. The uris returns the data for the view. For an object reference, the objectRefID, methodCode, and uris are required . modify indicates that a property is being modified
- confirmationRequiredIndicator IndicatordefaulttypeV01? - Boolean expression
- commentAllowedIndicator IndicatordefaulttypeV01? - Boolean expression
- defaultIndicator IndicatordefaulttypeV01? - Boolean expression
- sequence SequencetypeV01? - Sequence of a related entity when included in the collection or a group
- attestation AttestationtypeV02? - Optional text provided to the user when they take an action to affirm to be correct, true, or genuine. Requires confirmation indicator to be set to true
- links LinktypeV02[]? - Links
adp.workerpayrollinstructions: AmounttypeV02![](/images/permalink.svg)
A representation of a monetary value
Fields
- amountValue decimal? - The monetary value of the object in which the amount is associated
- currencyCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
adp.workerpayrollinstructions: AmountValueType![](/images/permalink.svg)
Fields
- readOnly boolean? - True indicates that the property is marked read only in the given context
- optional boolean? - True indicates that this property does not need to be valued
- hidden boolean? - True indicates that the property is carried in the message - to and from the System of Record, but is not exposed in the UI
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- shortLabelName string? - Provides a client defined UI label for the property which is less than an average of 20 characters in length.
- longLabelName string? - Provides a client defined UI long label for the property.
- minLength int? - Indicates the minimum length required for a property.
- maxLength int? - Indicates the maximum length supported for a property
- minAmountValue decimal? - Indicates the minimum amout value required for a property.
- maxAmountValue decimal? - Indicates the maximum amount value supported for a property
- minValue decimal? - Indicates the minimum value required for a property.
- maxValue decimal? - Indicates the maximum value supported for a property
- multipleOf decimal? - Indicates that the value must be a multiple of this value or divisible by this value.
- default decimal? - Indicates the default value which should be populated by default
- pattern string? - Indicates a regular expression on the required pattern for the value
- masking MaskingRuleType? -
- 'equals string[]? - Provides 1 to many properties which the value of this property must be equal to. If the property is equal to any of the value of the properties then the validation is successful.
- greaterThan string[]? - The value of the related property must be greater than the value of all the given properties in the array.
- lessThan string[]? - The value of the related property must be less than the value of all the given properties in the array.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType string? - Data type of the attribute
- dependencyLinks LinktypeV02[]? - Dependency links
adp.workerpayrollinstructions: ArgumentType![](/images/permalink.svg)
Fields
- argumentName string? - Argument name to be passed in
- argumentPath string? - The path of the argument to be passed in
- argumentValue string? - The value of the argument name to be passed in
adp.workerpayrollinstructions: AssignedGroup![](/images/permalink.svg)
Fields
- groupID string? - The unique identifier of the group
- groupName string? - The name of the group
- assignedGroupMembers AssignedGroupMember[]? - Associates that are part of the group(s) assigned to the review event. The actor is the member that actually completes the event.
adp.workerpayrollinstructions: AssignedGroupMember![](/images/permalink.svg)
An instance of an Associate that is part of the group(s) assigned to the review event. The actor is the member that actually completes the event.
Fields
- associateOID string? - The unique identifier of an associate who originated the event or a process
- formattedName string? - Human readable name of the actor
adp.workerpayrollinstructions: AttestationtypeV02![](/images/permalink.svg)
Optional text provided to the user when they take an action to affirm to be correct, true, or genuine. Requires confirmation indicator to be set to true
Fields
- actionBlockIndicator IndicatordefaulttypeV01? - Boolean expression
- messageTxt string? - Message to present to the user. This is mutuallly exclusive with the messageUri which is an external link to the message. If the text is sizable and fairly static then it should be an external link which may be cached
- messageUri UritypeV01? - The URI of the related entity
adp.workerpayrollinstructions: BenefitInstructionCoverageItem![](/images/permalink.svg)
Fields
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- benefitAreaCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- coverageLevelCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- effectiveTimePeriod DatetimeperiodtypeV01? - The string reprersentation of the date range. Used to specify effective period. Follows the ISO-8601:2000 format.
- coverageAmount EffectivedatedamounttypeV02? - Type to include the code and effective date (ISO-8601:2000 format)
- individualCoverages IndividualCoverageItem[]? - List of individuals eligible to be covered in the associated plan offering with the individual coverage amounts
adp.workerpayrollinstructions: BooleanType![](/images/permalink.svg)
Fields
- readOnly boolean? - True indicates that the property is marked read only in the given context
- optional boolean? - True indicates that this property does not need to be valued
- hidden boolean? - True indicates that the property is carried in the message - to and from the System of Record, but is not exposed in the UI
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- shortLabelName string? - Provides a client defined UI label for the property which is less than an average of 20 characters in length.
- longLabelName string? - Provides a client defined UI long label for the property
- default boolean? - Indicates the default value which should be populated by default
- 'equals string[]? - Provides 1 to many properties which the value of this property must be equal to. If the property is equal to any of the value of the properties then the validation is successful.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType string? - Data type of the attribute
- dependencyLinks LinktypeV02[]? -
adp.workerpayrollinstructions: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
adp.workerpayrollinstructions: CodeListItemType![](/images/permalink.svg)
Fields
- code string? - The code value for the related entity
- name string? - The code name for description of the related code
- valueDescription string? - Additional list item description
- valuePattern string? - Allows for specifying the pattern (regex) for validating the list values
- filter string? - Allows for filtering the code list
- inactiveIndicator IndicatorType? -
- defaultIndicator IndicatorType? -
- links LinktypeV02[]? -
adp.workerpayrollinstructions: CodelistitemtypeV02![](/images/permalink.svg)
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- valueDescription string? - Additional list item description
- foreignKey string? - Allows for filtering the code list
- inactiveIndicator IndicatortypeV01? - Boolean expression
- defaultIndicator IndicatortypeV01? - Boolean expression
adp.workerpayrollinstructions: CodeListType![](/images/permalink.svg)
Fields
- codeListTitle string? - Code list title
- exclusiveIndicator IndicatorType? -
- listItems CodeListItemType[]? -
- links LinktypeV02[]? -
adp.workerpayrollinstructions: CodelisttypeV03![](/images/permalink.svg)
A reference to the codeList which returns the possible values for the query option
Fields
- codeListTitle string? - Code list title
- exclusiveIndicator IndicatortypeV01? - Boolean expression
- listItems CodelistitemtypeV02[]? - List items
- links LinktypeV02[]? - Links
adp.workerpayrollinstructions: CodetypeV01![](/images/permalink.svg)
The code for the related entity
Fields
- codeValue string? - The code for the related entity.
- shortName string? - Short description of the related code not to exceed 25 characters
- longName string? - Long description of the related code
adp.workerpayrollinstructions: CodetypeV02![](/images/permalink.svg)
The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: CommunicationtypeV02![](/images/permalink.svg)
Communication objects to include various communication mechanisms, e,g, phone, email, etc.
Fields
- landlines CommunicationtypeV02Landlines[]? - A list of land-line telephone numbers
- mobiles CommunicationtypeV02Landlines[]? - A list of mobile telephone numbers
- emails EmailContactCommunicationType[]? - A list of email addresses
- socialNetworks SocialNetworkContactCommunicationType[]? - A list of social networks addresses
- faxes CommunicationtypeV02Landlines[]? - A list of fax telephone numbers
- pagers CommunicationtypeV02Landlines[]? - A list of pager telephone numbers
- internetAddresses InternetAddressWithItemID[]? - A list of internet URIs
- instantMessages CommunicationtypeV02Instantmessages[]? - A list of instant messages URIs
adp.workerpayrollinstructions: CommunicationtypeV02Instantmessages![](/images/permalink.svg)
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- uri UritypeV01? - The URI of the related entity
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- notificationIndicator boolean? -
adp.workerpayrollinstructions: CommunicationtypeV02Landlines![](/images/permalink.svg)
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- countryDialing string? - The country dialing code is the national prefix to be used when dialing TO that particular country FROM another country.
- areaDialing string? - The local area dialing code for a telephone number.
- dialNumber string? - The local communication number, not including country dialing or area dialing codes. If component parts of the telephone number are being communicated then the dialNumber is required.
- extension string? - The extension of the local communication number. In the case of a Telephone Number accessing a Pager Network, the extension may be the Pager Identification Number required to leave a message for the Pager Number (i.e. Pager Pin). These are mutually exclusive.
- access string? - National Direct Dialing Prefix. Also known as the trunk prefix or National Prefix. It is the number to be dialed in a domestic telephone call, preceding any necessary area code and subscriber number (i.e. dial number). When calling from outside of the country, the national direct dial prefix is omitted by the caller. In Australia, Germany, and United Kingdom the trunk prefix is 0. In the US and Canada it is 1.
- formattedNumber string? - The formatted telephone number. The component parts of the telephone are put together into a presentation pattern as defined by the regex format specified. Please note that is used as an escape character in regex, but a double is needed to escape within the json schema. The regex will accept +CC NNNNNNNNNNNNNN where + is the symbol indicating the caller to enter their country specific code to call from outside the country. CC is the country code for an international number (optional), and the area code and dial number. The local access code (i.e. 1 (201) 333 4444. 1 is the access code in US) is not passed. The UI will present the phone number following its own presentation convention
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- notificationIndicator boolean? -
adp.workerpayrollinstructions: ConfirmmessagetypeV01![](/images/permalink.svg)
The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
Fields
- confirmMessageID IdtypeV01? - The unique identifier of the related entity
- createDateTime DatetimetypeV01? - The string reprersentation of the date-time value. Follows the ISO-8601:2000 format
- requestReceiptDateTime DatetimetypeV01? - The string reprersentation of the date-time value. Follows the ISO-8601:2000 format
- protocolStatusCode CodetypeV01? - The code for the related entity
- protocolCode CodetypeV01? - The code for the related entity
- requestID IdtypeV01? - The unique identifier of the related entity
- requestStatusCode ConfirmmessagetypeV01Requeststatuscode? - The process results status code for the request.
- requestMethodCode ConfirmmessagetypeV01Requestmethodcode? - The method that was used on the request corresponding to this message instance.
- sessionID IdtypeV01? - The unique identifier of the related entity
- requestETag string? - The entity tag of the entity in the request.
- requestLink LinktypeV02? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
- processingStatusCode ConfirmmessagetypeV01Processingstatuscode? - Processing status of the related request message.
- processMessages ProcessmessageV01[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
- resourceMessages ConfirmmessagetypeV01Resourcemessages[]? - resource Message contains the resource-specific processing results for resources being managed in the request. A resource may have its processing reported as: succeeded or failed. It must be used to represent resource-specific messages. In the case of a request managing multiple resources and resource-specific messages are to be returned, then this array will contain one object for each such resource of the request.
adp.workerpayrollinstructions: ConfirmmessagetypeV01Expressionlanguagecode![](/images/permalink.svg)
Identifies the language used for expressions communicated in this message.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: ConfirmmessagetypeV01Processingstatuscode![](/images/permalink.svg)
Processing status of the related request message.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: ConfirmmessagetypeV01Requestmethodcode![](/images/permalink.svg)
The method that was used on the request corresponding to this message instance.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: ConfirmmessagetypeV01Requeststatuscode![](/images/permalink.svg)
The process results status code for the request.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: ConfirmmessagetypeV01Resourcemessages![](/images/permalink.svg)
Each object contains detailed information for a resource referenced in the original request.
Fields
- resourceMessageID IdtypeV01? - The unique identifier of the related entity
- resourceStatusCode ResourceMessageResourceStatus? - The processing results status code of the resource of the request.
- resourceLink LinktypeV02? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
- processMessages ProcessMessageWithResourceStatusCode[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
adp.workerpayrollinstructions: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
adp.workerpayrollinstructions: CoordinatetypeV02![](/images/permalink.svg)
The coordinates of the location
Fields
- latitude decimal? - The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees
- longitude decimal? - The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees
adp.workerpayrollinstructions: CountrysubdivisiontypeV02![](/images/permalink.svg)
A country sub-division correlating to a administrative level one or two levels below country. For example, in the United States, this might be a state or a county
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- subdivisionType string? - The type of a country sub-division, e.g. state, county
adp.workerpayrollinstructions: DatetimeperiodtypeV01![](/images/permalink.svg)
The string reprersentation of the date range. Used to specify effective period. Follows the ISO-8601:2000 format.
Fields
- startDateTime DatetimetypeV01? - The string reprersentation of the date-time value. Follows the ISO-8601:2000 format
- endDateTime DatetimetypeV01? - The string reprersentation of the date-time value. Follows the ISO-8601:2000 format
adp.workerpayrollinstructions: DeductiongoaltypeV02![](/images/permalink.svg)
The deduction goal
Fields
- goalStartDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- goalLimitAmount AmounttypeV02? - A representation of a monetary value
- goalID SimpleidtypeV02? - The simple (string) identifier of an object
- goalBalanceAmount AmounttypeV02? - A representation of a monetary value
adp.workerpayrollinstructions: DependencyListType![](/images/permalink.svg)
List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
adp.workerpayrollinstructions: DepositaccounttypeV02![](/images/permalink.svg)
Bank account info
Fields
- BBAN SimpleidtypeV02? - The simple (string) identifier of an object
- IBAN SimpleidtypeV02? - The simple (string) identifier of an object
- UPIC SimpleidtypeV02? - The simple (string) identifier of an object
- financialParty FinancialpartytypeV02? - An institution, such as a bank, building society, credit union, stock brokerage, or similar business; established primarily to provide financial services and financial transactions
- financialAccount FinancialaccounttypeV02? - Bank account info
adp.workerpayrollinstructions: DisallowItemType![](/images/permalink.svg)
Fields
- itemID ItemIDType? - A unique identifier of an object within the collection
adp.workerpayrollinstructions: EffectivedatedamounttypeV02![](/images/permalink.svg)
Type to include the code and effective date (ISO-8601:2000 format)
Fields
- amountValue decimal? - The monetary value of the object in which the amount is associated
- currencyCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- effectiveDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
adp.workerpayrollinstructions: EmailContactCommunicationType![](/images/permalink.svg)
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- emailUri EmailuritypeV02? - The email URI of the related entity
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- notificationIndicator boolean? -
adp.workerpayrollinstructions: FeetypeV02![](/images/permalink.svg)
A representation of a fee amount
Fields
- amountValue decimal? - The monetary value of the object in which the amount is associated
- currencyCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- unitTimeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- percentage PercentagetypeV02? - A representation of a monetary value
- percentageBasisCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
adp.workerpayrollinstructions: FinancialaccounttypeV02![](/images/permalink.svg)
Bank account info
Fields
- accountNumber SimpleidtypeV02? - The simple (string) identifier of an object
- accountName string? - The name of the related account
- typeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- currencyCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
adp.workerpayrollinstructions: FinancialpartytypeV02![](/images/permalink.svg)
An institution, such as a bank, building society, credit union, stock brokerage, or similar business; established primarily to provide financial services and financial transactions
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- address OrganizationaddresstypeV02? - organization address objects / components
- financialPartyID IdtypeV02? - The unique identifier of the related entity
- SWIFTCode SimpleidtypeV02? - The simple (string) identifier of an object
- branchNameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- routingTransitID IdtypeV02? - The unique identifier of the related entity
- communication CommunicationtypeV02? - Communication objects to include various communication mechanisms, e,g, phone, email, etc.
adp.workerpayrollinstructions: GeneralDeductionInstructionEventContext![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- itemID string? - The unique identifier of the related worker lien within a collection
- deductionCode PayrollinstructiontransformGeneraldeductioninstructionDeductioncode? - The code of the deduction. The code can be user defined or a statutory deduction
adp.workerpayrollinstructions: GeneralDeductionInstructionOutput![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- deductionCode PayrollinstructiontransformGeneraldeductioninstructionDeductioncode? - The code of the deduction. The code can be user defined or a statutory deduction
- deductionRate PayrollinstructiontransformGeneraldeductioninstructionDeductionrate? - The value of the associated deduction, e.g. the deduction amount
- deductionGoal PayrollinstructiontransformGeneraldeductioninstructionDeductiongoal? - A deduction goal
- itemID string? - The unique identifier of the item within a collection
adp.workerpayrollinstructions: GeneralDeductionInstructionTransform![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- deductionRate PayrollinstructiontransformGeneraldeductioninstructionDeductionrate? - The value of the associated deduction, e.g. the deduction amount
- deductionGoal GeneraldeductioninstructiontransformDeductiongoal? - A deduction goal
adp.workerpayrollinstructions: GeneraldeductioninstructiontransformDeductiongoal![](/images/permalink.svg)
A deduction goal
Fields
- goalStartDate string? - The date when the deduction goal was set
- goalLimitAmount PayrollinstructiontransformGeneraldeductioninstructionDeductiongoalGoallimitamount? - The value that cannot be exceeded - e.g the targeted goal amount
adp.workerpayrollinstructions: GovernmentiditemtypeV02![](/images/permalink.svg)
A government identifier, e.g. a national identity number or a social insurance number
Fields
- idValue string? - An actual ID
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- countryCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- statusCode StatustypeV02? - Status to include the status code and effective date (ISO-8601:2000 format)
- expirationDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
adp.workerpayrollinstructions: HelperMessageType![](/images/permalink.svg)
Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
Fields
- messageTxt string? - Message to present to the user.
- links LinktypeV02[]? - Links
adp.workerpayrollinstructions: IdtypeV01![](/images/permalink.svg)
The unique identifier of the related entity
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: IdtypeV02![](/images/permalink.svg)
The unique identifier of the related entity
Fields
- idValue string? - An actual ID value
- schemeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
adp.workerpayrollinstructions: IndividualCoverageItem![](/images/permalink.svg)
Fields
- individualID IdtypeV02? - The unique identifier of the related entity
- relationshipTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- coverageAmount EffectivedatedamounttypeV02? - Type to include the code and effective date (ISO-8601:2000 format)
adp.workerpayrollinstructions: InternetAddressWithItemID![](/images/permalink.svg)
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- uri UritypeV01? - The URI of the related entity
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
adp.workerpayrollinstructions: LinkType![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- canonicalUri UriType? - URI type
- href UriType? - URI type
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- mediaType string? - The media type that the linked resource will return (Response)
- method HttpMethodType? - Simple (string) code identifying the http method used to invoke the API
- payloadArguments ArgumentType[]? - Payload arguments
adp.workerpayrollinstructions: LinktypeV02![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href UritypeV01? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri UritypeV01? - The URI of the related entity
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: LinktypeV02Payloadarguments![](/images/permalink.svg)
Fields
- argumentPath string? - Code value (typically a key field) of the code list item
- argumentValue string? - Code value (typically a key field) of the code list item
adp.workerpayrollinstructions: MaskingRuleType![](/images/permalink.svg)
Fields
- authorizationRequiredIndicator IndicatorType? -
- authorizationResourceID SimpleIDType? -
- links LinktypeV02[]? -
adp.workerpayrollinstructions: MessagetypecodetypeV01![](/images/permalink.svg)
Schema describing the type of the user or developer message
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: MessagetypeV01![](/images/permalink.svg)
Representation of a message.
Fields
- codeValue string? - The code associated with the message description.
- title string? - Title of the message description.
- messageTxt string? - The value/content of the message description.
- links LinktypeV02[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
adp.workerpayrollinstructions: MetatypeV02![](/images/permalink.svg)
Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
Fields
- startSequence SequencetypeV01? - Sequence of a related entity when included in the collection or a group
- completeIndicator IndicatortypeV01? - Boolean expression
- totalNumber int? - Number of total instance resources in an instance resource set. Note: An instance resource set is a set of instance resources that is determined by a server to satisfy the sets membership criteria (i.e., selection, filter, expansion and search criteria) of a resource management operation (e.g. GET request) upon a collection resource
- resourceSetID SimpleidtypeV02? - The simple (string) identifier of an object
- links LinktypeV02[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
adp.workerpayrollinstructions: NumberType![](/images/permalink.svg)
Fields
- readOnly boolean? - True indicates that the property is marked read only in the given context
- optional boolean? - True indicates that this property does not need to be valued
- hidden boolean? - True indicates that the property is carried in the message - to and from the System of Record, but is not exposed in the UI
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- shortLabelName string? - Provides a client defined UI label for the property which is less than an average of 20 characters in length.
- longLabelName string? - Provides a client defined UI long label for the property.
- minLength int? - Indicates the minimum length required for a property.
- maxLength int? - Indicates the maximum length supported for a property
- minValue decimal? - Indicates the minimum value required for a property.
- maxValue decimal? - Indicates the maximum value supported for a property
- multipleOf decimal? - Indicates that the value must be a multiple of this value or divisible by this value.
- default decimal? - Indicates the default value which should be populated by default
- pattern string? - Indicates a regular expression on the required pattern for the value
- masking MaskingRuleType? -
- 'equals string[]? - Provides 1 to many properties which the value of this property must be equal to. If the property is equal to any of the value of the properties then the validation is successful.
- greaterThan string[]? - The value of the related property must be greater than the value of all the given properties in the array.
- lessThan string[]? - The value of the related property must be less than the value of all the given properties in the array.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType MetaDataType? -
- dependencyLinks LinktypeV02[]? -
adp.workerpayrollinstructions: OAuth2ClientCredentialsGrantConfig![](/images/permalink.svg)
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://accounts.adp.com/auth/oauth/v2/token") - Token URL
adp.workerpayrollinstructions: ObjectType![](/images/permalink.svg)
Fields
- readOnly boolean? - True indicates that the property is marked read only in the given context
- optional boolean? - True indicates that this property does not need to be valued
- hidden boolean? - True indicates that the property is carried in the message - to and from the System of Record, but is not exposed in the UI
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType MetaDataType? -
- dependencyLinks LinktypeV02[]? -
adp.workerpayrollinstructions: OrganizationaddresstypeV02![](/images/permalink.svg)
organization address objects / components
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- attentionOfName string? - Attention of Name
- careOfName string? - Care Of Name
- lineOne string? - Line One of Street Address Information
- lineTwo string? - Line Two of Street Address Information
- lineThree string? - Line Three of Street Address Information
- cityName string? - A city in the context of an address
- countrySubdivisionLevel1 CountrysubdivisiontypeV02? - A country sub-division correlating to a administrative level one or two levels below country. For example, in the United States, this might be a state or a county
- countryCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- postalCode string? - The string of characters used to identify the postal code
- geoCoordinate CoordinatetypeV02? - The coordinates of the location
- scriptCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- lineFour string? - Line Four of Street Address Information
- lineFive string? - Line Five of Street Address Information
- buildingNumber string? - The number of a building in the context of a physical address, e.g. House Number
- buildingName string? - The name of a building in the context of a physical address, e.g. Rockefeller Center
- blockName string? - The name the block
- streetName string? - The name of the street
- streetTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- unit string? - A unit in the context of an address, e.g. an Apartment Number or an Office
- floor string? - A floor in the context of an address
- stairCase string? - A reference to a particular staircase in the context of an address
- door string? - A reference to a particular door in the context of an address. e.g. Apartment Number
- postOfficeBox string? - A post office box
- deliveryPoint string? - A way to identify a specific delivery location, e.g. a mail-stop
- plotID string? - A way to identify a building plot, e.g. a specific building construction site
- countrySubdivisionLevel2 CountrysubdivisiontypeV02? - A country sub-division correlating to a administrative level one or two levels below country. For example, in the United States, this might be a state or a county
adp.workerpayrollinstructions: PartytypeV02![](/images/permalink.svg)
Object describing the details of a party, either person or organization
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- address OrganizationaddresstypeV02? - organization address objects / components
- partyID IdtypeV02? - The unique identifier of the related entity
- partyTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- governmentIDs GovernmentiditemtypeV02[]? - A list of government identifiers
- legalName string? - The name of the party
- contactName PersonnametypeV02? - Object describing the details of a person name
- contactCommunication CommunicationtypeV02? - Communication objects to include various communication mechanisms, e,g, phone, email, etc.
adp.workerpayrollinstructions: PaymentScheduleLienFundsDisbursement![](/images/permalink.svg)
Denotes when payment should be remitted
Fields
- scheduleTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- accruedPaymentAmount AmounttypeV02? - A representation of a monetary value
- adjustmentValue decimal? - The numeric value associated to the adjustment, e.g if scheduleCode is 'paydate + days' and adjustmentValue = 3, then Payment will be remitted on paydate + 3 days
- unitTimeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
adp.workerpayrollinstructions: PayrollGeneralDeductionInstruction![](/images/permalink.svg)
Fields
- deductionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- deductionRate RatetypeV03? - A representation of a pay rate
- deductionGoal DeductiongoaltypeV02? - The deduction goal
- deductionStartDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- actions ActiontypeV02[]? - Actions which the user is allowed to initiate against the related instance.
adp.workerpayrollinstructions: PayrollInstructionEventContext![](/images/permalink.svg)
Payroll instruction
Fields
- payrollProfileID string? - The payroll profile ID
- payrollRegionCode PayrollinstructioneventcontextPayrollregioncode? - The region in which the payroll is processed
- payrollGroupCode PayrollinstructioneventcontextPayrollgroupcode? - The payroll group relevant to payroll processing
- payrollFileNumber string? - The payroll file number
- payrollAgreementID string? - The payroll agreement id
- itemID string? - The unique identifier of the related worker lien within a collection
adp.workerpayrollinstructions: Payrollinstructioneventcontext1![](/images/permalink.svg)
Payroll instruction
Fields
- payrollProfileID string? - The payroll profile ID
- payrollRegionCode PayrollinstructioneventcontextPayrollregioncode? - The region in which the payroll is processed
- payrollGroupCode PayrollinstructioneventcontextPayrollgroupcode? - The payroll group relevant to payroll processing
- payrollFileNumber string? - The payroll file number
- itemID string? - The unique identifier of the related worker lien within a collection
- generalDeductionInstruction GeneralDeductionInstructionEventContext? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: Payrollinstructioneventcontext2![](/images/permalink.svg)
Payroll instruction
Fields
- payrollProfileID string? - The payroll profile ID
- payrollRegionCode PayrollinstructioneventcontextPayrollregioncode? - The region in which the payroll is processed
- payrollGroupCode PayrollinstructioneventcontextPayrollgroupcode? - The payroll group relevant to payroll processing
- payrollFileNumber string? - The payroll file number
- payrollAgreementID string? - The payroll agreement id
- itemID string? - The unique identifier of the related worker lien within a collection
- generalDeductionInstruction GeneralDeductionInstructionEventContext? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: PayrollinstructioneventcontextPayrollgroupcode![](/images/permalink.svg)
The payroll group relevant to payroll processing
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: PayrollinstructioneventcontextPayrollregioncode![](/images/permalink.svg)
The region in which the payroll is processed
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: PayrollInstructionOutput![](/images/permalink.svg)
Payroll instruction
Fields
- payrollProfileID string? - The payroll profile ID
- payrollRegionCode PayrollinstructioneventcontextPayrollregioncode? - The region in which the payroll is processed
- payrollGroupCode PayrollinstructioneventcontextPayrollgroupcode? - The payroll group relevant to payroll processing
- payrollFileNumber string? - The payroll file number
- payrollAgreementID string? - The payroll agreement id
- itemID string? - The unique identifier of the related worker lien within a collection
- generalDeductionInstruction GeneralDeductionInstructionOutput? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: Payrollinstructionoutput1![](/images/permalink.svg)
Payroll instruction
Fields
- payrollProfileID string? - The payroll profile ID
- payrollRegionCode PayrollinstructioneventcontextPayrollregioncode? - The region in which the payroll is processed
- payrollGroupCode PayrollinstructioneventcontextPayrollgroupcode? - The payroll group relevant to payroll processing
- payrollFileNumber string? - The payroll file number
- itemID string? - The unique identifier of the related worker lien within a collection
- generalDeductionInstruction GeneralDeductionInstructionOutput? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: PayrollInstructions![](/images/permalink.svg)
Fields
- payrollInstructions PayrollinstructionsPayrollinstructions[]? -
- meta MetatypeV02? - Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
- confirmMessage ConfirmmessagetypeV01? - The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
adp.workerpayrollinstructions: PayrollinstructionsBenefitinstructions![](/images/permalink.svg)
Fields
- deductionRate RatetypeV03? - A representation of a pay rate
- deductionGoal DeductiongoaltypeV02? - The deduction goal
- benefitCoverages BenefitInstructionCoverageItem[]? -
- deductionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- deductionStartDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- actions ActiontypeV02[]? - Actions which the user is allowed to initiate against the related instance.
adp.workerpayrollinstructions: PayrollinstructionsGarnishmentinstructions![](/images/permalink.svg)
Fields
- calculationFactorCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- garnishmentGoal DeductiongoaltypeV02? - The deduction goal
- garnishmentAmount AmounttypeV02? - A representation of a monetary value
- garnishmentPercentage PercentagetypeV02? - A representation of a monetary value
- garnishmentStartDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- garnishmentEndDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- excludedEarningCodes CodetypeV02[]? - Allows specific earnings to be excluded from the garnishment
- excludedDeductionCodes CodetypeV02[]? - Allows specific deductions to be excluded from the garnishment
- deductionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- workerLien WorkerLienOutput? - Worker lien
- actions ActiontypeV02[]? - Actions which the user is allowed to initiate against the related instance.
adp.workerpayrollinstructions: PayrollinstructionsPayrollinstructions![](/images/permalink.svg)
Fields
- payrollRegionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- payrollGroupCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- payrollFileNumber SimpleidtypeV02? - The simple (string) identifier of an object
- payrollProfileID SimpleidtypeV02? - The simple (string) identifier of an object
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- generalDeductionInstructions PayrollGeneralDeductionInstruction[]? - An array of instructions for general deductions
- garnishmentInstructions PayrollinstructionsGarnishmentinstructions[]? - An array of instructions for garnishment deductions
- benefitInstructions PayrollinstructionsBenefitinstructions[]? - An array of instructions for general deductions
- retirementPlanInstructions PayrollinstructionsRetirementplaninstructions[]? - An array of instructions for retirement plans
- links LinktypeV02[]? -
adp.workerpayrollinstructions: PayrollinstructionsRetirementplaninstructions![](/images/permalink.svg)
Fields
- deductionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- calculationFactorCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- contributionRate RatetypeV03? - A representation of a pay rate
- contributionGoal DeductiongoaltypeV02? - The deduction goal
- contributionStartDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- actions ActiontypeV02[]? - Actions which the user is allowed to initiate against the related instance.
adp.workerpayrollinstructions: PayrollInstructionTransform![](/images/permalink.svg)
Payroll instruction
Fields
- generalDeductionInstruction PayrollinstructiontransformGeneraldeductioninstruction? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: Payrollinstructiontransform1![](/images/permalink.svg)
Payroll instruction
Fields
- generalDeductionInstruction GeneralDeductionInstructionTransform? - Data which is transformed as a result of the event
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstruction![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- deductionCode PayrollinstructiontransformGeneraldeductioninstructionDeductioncode? - The code of the deduction. The code can be user defined or a statutory deduction
- deductionRate PayrollinstructiontransformGeneraldeductioninstructionDeductionrate? - The value of the associated deduction, e.g. the deduction amount
- deductionGoal PayrollinstructiontransformGeneraldeductioninstructionDeductiongoal? - A deduction goal
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductioncode![](/images/permalink.svg)
The code of the deduction. The code can be user defined or a statutory deduction
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductiongoal![](/images/permalink.svg)
A deduction goal
Fields
- goalStartDate string? - The date when the deduction goal was set
- goalLimitAmount PayrollinstructiontransformGeneraldeductioninstructionDeductiongoalGoallimitamount? - The value that cannot be exceeded - e.g the targeted goal amount
- goalID string? - The unique identifier of the goal
- goalBalanceAmount PayrollinstructiontransformGeneraldeductioninstructionDeductiongoalGoalbalanceamount? - The value that has been added to the goal thus far
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductiongoalGoalbalanceamount![](/images/permalink.svg)
The value that has been added to the goal thus far
Fields
- amountValue decimal? - The monetary value of the object in which the amount is associated
- currencyCode string? - Standard currency code as per ISO 4212
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductiongoalGoallimitamount![](/images/permalink.svg)
The value that cannot be exceeded - e.g the targeted goal amount
Fields
- amountValue decimal? - The monetary value of the object in which the amount is associated
- currencyCode string? - Standard currency code as per ISO 4212
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductionrate![](/images/permalink.svg)
The value of the associated deduction, e.g. the deduction amount
Fields
- rateValue decimal? - The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20
- currencyCode string? - List of standard currency codes ISO 4217 For any given rate, either the currencyCode or the unitCode is present. In the example 5 US dollars per hour, the unitCode would not be present, and the currency code would be USD
- unitCode PayrollinstructiontransformGeneraldeductioninstructionDeductionrateUnitcode? - For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent
- baseUnitCode PayrollinstructiontransformGeneraldeductioninstructionDeductionrateBaseunitcode? - For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales
- baseMultiplierValue decimal? - For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductionrateBaseunitcode![](/images/permalink.svg)
For any given rate, the baseUnitCode is used to define the denominator of the rate, or rate over what. In the example 5 US dollars per hour, the baseUnitCode is hour. In the example 3 bags of rice per month, the baseUnitCode is month. If for example, the rate was 10 US dollars for every widget produced, the baseUnitCode would be widget. In the example, 20 percent of annual sales, the baseUnitCode would equate to annual sales
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: PayrollinstructiontransformGeneraldeductioninstructionDeductionrateUnitcode![](/images/permalink.svg)
For any given rate, either the currencyCode or the unitCode is present. In the example 3 bags of rice per month, currencyCode would not be present, and the unitCode would be bags of rice. In the example, 20 percent of annual sales, the unitCode would be percent
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: PercentagetypeV02![](/images/permalink.svg)
A representation of a monetary value
Fields
- percentageValue decimal? - The percentage value
- basisCode CodetypeV01? - The code for the related entity
adp.workerpayrollinstructions: PersonnametypeV02![](/images/permalink.svg)
Object describing the details of a person name
Fields
- givenName string? - The first name of the person
- middleName string? - Person middle name or initial
- familyName1 string? - Person family name 1
- familyName2 string? - Person family name 2
- formattedName string? - A formatted version of the person name
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- scriptCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- preferredSalutations SalutationtypeV02[]? - A list of preferred salutations
- titlePrefixCodes TitleaffixtypeV02[]? - Person title Prefix Codes
- nickName string? - A preferred name, e.g. a nickname
- generationAffixCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- qualificationAffixCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- titleAffixCodes TitleaffixtypeV02[]? - Person titles
- familyName1Prefix string? - Person family name pre-fix
- familyName2Prefix string? - Person family name pre-fix
- initials string? - Person initials
adp.workerpayrollinstructions: ProcessmessageV01![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID IdtypeV01? - The unique identifier of the related entity
- messageTypeCode MessagetypecodetypeV01? - Schema describing the type of the user or developer message
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links LinktypeV02[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage MessagetypeV01? - Representation of a message.
- developerMessage MessagetypeV01? - Representation of a message.
adp.workerpayrollinstructions: ProcessMessageWithResourceStatusCode![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID IdtypeV01? - The unique identifier of the related entity
- messageTypeCode MessagetypecodetypeV01? - Schema describing the type of the user or developer message
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links LinktypeV02[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage MessagetypeV01? - Representation of a message.
- developerMessage MessagetypeV01? - Representation of a message.
- resourceStatusCode CodetypeV01? - The code for the related entity
adp.workerpayrollinstructions: Processmessagewithresourcestatuscode1![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessageid? - An identifier for the instance of the process message.
- messageTypeCode WorkergeneraldeductioninstructionstarteventConfirmmessageMessagetypecode? - Process Message instances may be of type: success, warning, error, or info.
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links WorkergeneraldeductioninstructionstarteventConfirmmessageLinks1[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessage? - Message returned to the user
- developerMessage WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessage? - Message returned to the user
- resourceStatusCode WorkergeneraldeductioninstructionstarteventConfirmmessageResourcestatuscode? - DEPRECATED - Use messageTypeCode instead. The processing results status code of the resource of the request.
adp.workerpayrollinstructions: Processmessagewithresourcestatuscode2![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessageid? - An identifier for the instance of the process message.
- messageTypeCode WorkergeneraldeductioninstructionstarteventConfirmmessageMessagetypecode? - Process Message instances may be of type: success, warning, error, or info.
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links WorkergeneraldeductioninstructionchangeeventConfirmmessageLinks1[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessage? - Message returned to the user
- developerMessage WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessage? - Message returned to the user
- resourceStatusCode WorkergeneraldeductioninstructionstarteventConfirmmessageResourcestatuscode? - DEPRECATED - Use messageTypeCode instead. The processing results status code of the resource of the request.
adp.workerpayrollinstructions: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
adp.workerpayrollinstructions: RatetypeV03![](/images/permalink.svg)
A representation of a pay rate
Fields
- rateValue decimal? - The numeric value associated to the rate. In the example 5 US dollars per hour, the number 5 is the rate value. In the example 3 bags of rice per month, the number 3 is the rate value. In the example, 20 percent of annual sales, the amountValue would be 20
- currencyCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- unitCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- baseUnitCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- baseMultiplierValue decimal? - For any given rate, the base rate value is presumed to be 1, e.g. per one hour, per one month. If for example, the rate was 10 US dollars for every widget produced, the base rate value is presumed to be one and there is no need to communicate a baseMultiplierValue. If however, the rate was 10 US Dollars for every 3 widgets produced, the baseMultiplierValue would be 3
adp.workerpayrollinstructions: ResourceMessageResourceStatus![](/images/permalink.svg)
The processing results status code of the resource of the request.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: SalutationtypeV02![](/images/permalink.svg)
A preferred salutation, e.g. Mr., Dr., etc.
Fields
- salutationCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- typeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- sequenceNumber SequencetypeV01? - Sequence of a related entity when included in the collection or a group
adp.workerpayrollinstructions: SocialNetworkContactCommunicationType![](/images/permalink.svg)
Fields
- nameCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- uri UritypeV01? - The URI of the related entity
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- notificationIndicator boolean? -
adp.workerpayrollinstructions: StatustypeV02![](/images/permalink.svg)
Status to include the status code and effective date (ISO-8601:2000 format)
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- effectiveDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
adp.workerpayrollinstructions: StringCodeListType![](/images/permalink.svg)
Fields
- codeList CodelisttypeV03? - A reference to the codeList which returns the possible values for the query option
- readOnly IndicatorType? -
- optional IndicatorType? -
- hidden IndicatorType? -
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- shortLabelName string? - Provides a client defined UI label for the property which is less than an average of 20 characters in length.
- longLabelName string? - Provides a client defined UI long label for the property.
- minLength int? - Indicates the minimum length required for a property.
- maxLength int? - Indicates the maximum length supported for a property
- default string? - Indicates the default value which should be populated by default
- pattern string? - Indicates a regular expression on the required pattern for the value
- masking MaskingRuleType? -
- 'equals string[]? - Provides 1 to many properties which the value of this property must be equal to. If the property is equal to any of the value of the properties then the validation is successful.
- greaterThan string[]? - The value of the related property must be greater than the value of all the given properties in the array.
- lessThan string[]? - The value of the related property must be less than the value of all the given properties in the array.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType MetaDataType? -
- valueSet ValueSetType? -
- dependencyLinks LinktypeV02[]? -
adp.workerpayrollinstructions: StringType![](/images/permalink.svg)
Fields
- readOnly IndicatorType? -
- optional IndicatorType? -
- hidden IndicatorType? -
- sequence SequenceType? - A number which provides the sequence that this property should be presented in relation to other properties.
- disallow DisallowItemType[]? - Specified on a target property. If the passed conditions are true then this property is disallowed and therefore, not presented to a user.
- shortLabelName string? - Provides a client defined UI label for the property which is less than an average of 20 characters in length.
- longLabelName string? - Provides a client defined UI long label for the property.
- minLength int? - Indicates the minimum length required for a property.
- maxLength int? - Indicates the maximum length supported for a property
- default string? - Indicates the default value which should be populated by default
- pattern string? - Indicates a regular expression on the required pattern for the value
- masking MaskingRuleType? -
- 'equals string[]? - Provides 1 to many properties which the value of this property must be equal to. If the property is equal to any of the value of the properties then the validation is successful.
- greaterThan string[]? - The value of the related property must be greater than the value of all the given properties in the array.
- lessThan string[]? - The value of the related property must be less than the value of all the given properties in the array.
- dependencies DependencyListType? - List conditional dependencies of supported properties (readOnly, pattern, hidden, disallow etc.) of an attribute or an object. Dependencies can be defined using oneOf (OR) / allOf (AND) object. oneOf - successful if one of the conditions satisfies, allOf - successful if all the conditions satisfies. Refer API specification for dependencies context object syntax and rules. Dependencies context cannot be validated against context schema if dependencies is defined context JSON, because the dependencies JSON structure is dynamically defined for attributes and the not defined in the context schema. Attribute level properties and dependencies properties are mutually exclusive, example - readOnly property can be set either at attribute level or inside dependencies. If both hidden and disallow properties are set inside dependencies or at attribute level, hidden property takes precedence.
- helperMessage HelperMessageType? - Helper text provided to the user when they take an action to affirm to be correct, true, or genuine.
- dataType MetaDataType? -
- valueSet ValueSetType? -
- dependencyLinks LinktypeV02[]? -
adp.workerpayrollinstructions: TitleaffixtypeV02![](/images/permalink.svg)
Person titles, e.g. social, professional, generational, etc.
Fields
- affixCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- sequenceNumber SequencetypeV01? - Sequence of a related entity when included in the collection or a group
adp.workerpayrollinstructions: ValueSetItemType![](/images/permalink.svg)
The value set item type
Fields
- idValue string? - The code for the related entity
- itemDescription string? - Short description of the related code
- defaultIndicator boolean? - Indicates if the current value is a default (pre-selected)
adp.workerpayrollinstructions: ValueSetMeta![](/images/permalink.svg)
Fields
- idValuePath string? - Code value (typically a key field) of the code list item
- itemDescriptionPath string? - Short name field of the code list item
adp.workerpayrollinstructions: ValueSetType![](/images/permalink.svg)
Fields
- meta ValueSetMeta? -
- valueSetListItems ValueSetItemType[]? -
- links LinktypeV02[]? -
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionChangeEvent![](/images/permalink.svg)
Fields
- meta WorkergeneraldeductioninstructionchangeeventMeta? - Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
- confirmMessage WorkergeneraldeductioninstructionchangeeventConfirmmessage? - The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventActasparty![](/images/permalink.svg)
The party (client employee) information that the actor is acting as to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) in read only mode.
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
- assignedGroups AssignedGroup[]? - An event instance
- organizationOID string? - A unique identifier of a client employee's organization id
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventActor![](/images/permalink.svg)
The actor is the party that completed the recording of the event
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
- assignedGroups AssignedGroup[]? - An event instance
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessage![](/images/permalink.svg)
The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
Fields
- confirmMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageConfirmmessageid? - An identifier for the instance of the confirm message.
- createDateTime string? - The date & time that the message instance was generated.; follows the ISO-8601:2000 format: 2008-05-11T15:30:00-06:00.
- requestReceiptDateTime string? - The date & time that the request submitted by the client was received. Note, this timestamp may not be the same as the time the client actually submitted the request if there is a queuing mechanism between the client and server processing the request; it follows the ISO-8601:2000 format: 2008-05-11T15:30:00-06:00.
- protocolStatusCode WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolstatuscode? - Protocol-specific response status code.
- protocolCode WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolcode? - Code that identifies the protocol used for the request.
- requestID WorkergeneraldeductioninstructionstarteventConfirmmessageRequestid? - The identifier of the request that generated this response.
- requestStatusCode ConfirmmessagetypeV01Requeststatuscode? - The process results status code for the request.
- requestMethodCode ConfirmmessagetypeV01Requestmethodcode? - The method that was used on the request corresponding to this message instance.
- sessionID WorkergeneraldeductioninstructionstarteventConfirmmessageSessionid? - A session identifier if one is available.
- requestETag string? - The entity tag of the entity in the request.
- requestLink WorkergeneraldeductioninstructionchangeeventConfirmmessageRequestlink? - The link of the request that generated this response.
- processingStatusCode ConfirmmessagetypeV01Processingstatuscode? - Processing status of the related request message.
- processMessages WorkergeneraldeductioninstructionchangeeventConfirmmessageProcessmessages[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
- resourceMessages WorkergeneraldeductioninstructionchangeeventConfirmmessageResourcemessages[]? - resource Message contains the resource-specific processing results for resources being managed in the request. A resource may have its processing reported as: succeeded or failed. It must be used to represent resource-specific messages. In the case of a request managing multiple resources and resource-specific messages are to be returned, then this array will contain one object for each such resource of the request.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageLinks1![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageProcessmessages![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessageid? - An identifier for the instance of the process message.
- messageTypeCode WorkergeneraldeductioninstructionstarteventConfirmmessageMessagetypecode? - Process Message instances may be of type: success, warning, error, or info.
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links WorkergeneraldeductioninstructionchangeeventConfirmmessageLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessage? - Message returned to the user
- developerMessage WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessage? - Message returned to the user
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageRequestlink![](/images/permalink.svg)
The link of the request that generated this response.
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageResourcelink![](/images/permalink.svg)
The link of the request that generated this response.
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageResourcemessages![](/images/permalink.svg)
Each object contains detailed information for a resource referenced in the original request.
Fields
- resourceMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageResourcemessageid? - An identifier for the instance of the resource message.
- resourceStatusCode ResourceMessageResourceStatus? - The processing results status code of the resource of the request.
- resourceLink WorkergeneraldeductioninstructionchangeeventConfirmmessageResourcelink? - The link of the request that generated this response.
- processMessages Processmessagewithresourcestatuscode2[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessage![](/images/permalink.svg)
Message returned to the user
Fields
- codeValue string? - The code associated with the message description.
- title string? - Title of the message description.
- messageTxt string? - The value/content of the message description.
- links WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessageLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventConfirmmessageUsermessageLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventData![](/images/permalink.svg)
Event Data
Fields
- eventContext WorkergeneraldeductioninstructionchangeeventDataEventcontext? - Data which sets the context for the event. That is, the keys which set context
- transform WorkergeneraldeductioninstructionchangeeventDataTransform? - Data which is transformed as a result of the event
- output WorkergeneraldeductioninstructionchangeeventDataOutput? - Result of the event
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventDataEventcontext![](/images/permalink.svg)
Data which sets the context for the event. That is, the keys which set context
Fields
- contextExpressionID string? - A globally unique (GUID) identifier of the context expression. This conveys the context of the associated data. For example, if the context is set to Germany, the data would adhere to the business rules and formatting rules relevant to Germany
- 'worker WorkergeneraldeductioninstructionstarteventDataEventcontextWorker? - Worker
- payrollInstruction Payrollinstructioneventcontext1? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventDataOutput![](/images/permalink.svg)
Result of the event
Fields
- payrollInstruction Payrollinstructionoutput1? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventDataTransform![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- eventReasonCode WorkergeneraldeductioninstructionstarteventDataTransformEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage vs. Divorce vs. Separation
- eventStatusCode WorkergeneraldeductioninstructionstarteventDataTransformEventstatuscode? - This identifies the status of the event. An event that has been created, either by the system of record or as the result of a user, will have an event status code of Created. An event that is saved in a work in progress state (as determined by the permissable state codes), will have an event status code of InProgress. An event that has been recorded, will have an event status code of Complete. This value is set by the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
- notificationIndicator boolean? - True indicates that the requestor wants notifications on the status of the request
- payrollInstruction Payrollinstructiontransform1? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventEvents![](/images/permalink.svg)
An instance to capture the modification of a general deduction.
Fields
- eventID string? - The unique identifier of the event instance. This is set by the system of record once an event is recorded as in progress or complete
- serviceCategoryCode WorkergeneraldeductioninstructionstarteventServicecategorycode? - The service domain, e.g. HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist
- eventNameCode WorkergeneraldeductioninstructionstarteventEventnamecode? - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist
- eventTitle string? - The event title offers a way to describe a particular instance of an event at a level more granular than the event name, e.g. 2014 Annual Enrollment
- eventSubTitle string? - The event sub title provides event instance summary details, e.g. All Annual Enrollment elections become effective on January 1, 2014
- eventReasonCode WorkergeneraldeductioninstructionstarteventEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage or Divorce. This is optional and valued as defined by the system of record
- eventStatusCode WorkergeneraldeductioninstructionstarteventEventstatuscode? - This identifies the status of the event. An event that has been initiated by the system of record will have an event status code of created. An event that is saved in a work in progress state will have an event status code of inProgress. An event that has been recorded will have an event status code of complete. These values are set by the system of record and valued based on a standard codeslist
- priorityCode WorkergeneraldeductioninstructionstarteventPrioritycode? - This allows the system of record to prioritize events and is valued based on a standard codelist
- recordDateTime string? - This is the date time the event is recorded in the system of record with an event status code equal to complete. This value is set by the system of record
- creationDateTime string? - This is the date time the event is created. If a system of record creates the event instance, as in the case of an annual enrollment for example, then is sets the creation date time. If a user declares an event, then this is set to the date time when the first call is made to the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
- expirationDateTime string? - This value is set by the system of record and used to term the life cycle of an event instance.
- dueDateTime string? - This value is set by the system of record and allows for the presentation of a date by which the system of record would like the user to complete the event
- notificationIndicator boolean? - True indicates that the requestor wants notifications on the status of the request
- originator WorkergeneraldeductioninstructionstarteventOriginator? - An originator is a user, machine or event that triggered the event
- actor WorkergeneraldeductioninstructionchangeeventActor? - The actor is the party that completed the recording of the event
- actAsParty WorkergeneraldeductioninstructionchangeeventActasparty? - The party (client employee) information that the actor is acting as to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) in read only mode.
- onBehalfOfParty WorkergeneraldeductioninstructionchangeeventOnbehalfofparty? - The party (client employee) that the actor is acting on behalf of to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) and can take action on that person's behalf. The Actor may have access to certain features or screens that the Client Employee cannot view, e.g. diagnostics screens.
- links WorkergeneraldeductioninstructionchangeeventLinks[]? - Links
- data WorkergeneraldeductioninstructionchangeeventData? - Event Data
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventMeta![](/images/permalink.svg)
Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
Fields
- startSequence int? - The instance resource sequence (number) identifying the first resource returned in the response. The server generates this sequence. It is used by the client to determine the start sequence of the subsequent Get request
- completeIndicator boolean? - Indicates whether the response completes the return of all of the resources of the instance resource set to the requesting system
- totalNumber int? - Number of total instance resources in an instance resource set. Note: An instance resource set is a set of instance resources that is determined by a server to satisfy the sets membership criteria (i.e., selection, filter, expansion and search criteria) of a resource management operation (e.g. GET request) upon a collection resource
- resourceSetID string? - Unique identifier of the instance resource set. It is generated by the server as a result of the original Get request
- links WorkergeneraldeductioninstructionchangeeventMetaLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionChangeEventMeta![](/images/permalink.svg)
Fields
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventMetaLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- canonicalUri string? - A unique identifier of the feature/function/operation, the link poins to
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
- payLoadArguments LinktypeV02Payloadarguments[]? - Payload arguments
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventmetaMeta![](/images/permalink.svg)
Fields
- '\/serviceCategoryCode\/codeValue string - The service domain, e.g HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist.
- '\/eventNameCode\/codeValue string - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist.
- queryCriteria WorkergeneralDeductionInstructionchangeQueryCriterion[]? - A collection of query criteria
- '\/data\/eventContext WorkergeneraldeductioninstructionchangeeventmetaMetaDataeventcontext? -
- '\/data\/transforms WorkergeneraldeductioninstructionchangeeventmetaMetaDatatransforms[]? - A collection of transform rules
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventmetaMetaDataeventcontext![](/images/permalink.svg)
Fields
- '\/contextExpressionID StringType? -
- '\/worker ObjectType? -
- '\/worker\/associateOID StringType? -
- '\/payrollInstruction ObjectType? -
- '\/payrollInstruction\/payrollRegionCode StringCodeListType? -
- '\/payrollInstruction\/payrollRegionCode\/codeValue StringType? -
- '\/payrollInstruction\/payrollRegionCode\/shortName StringType? -
- '\/payrollInstruction\/payrollRegionCode\/longName StringType? -
- '\/payrollInstruction\/payrollGroupCode StringCodeListType? -
- '\/payrollInstruction\/payrollGroupCode\/codeValue StringType? -
- '\/payrollInstruction\/payrollGroupCode\/shortName StringType? -
- '\/payrollInstruction\/payrollGroupCode\/longName StringType? -
- '\/payrollInstruction\/payrollFileNumber StringType? -
- '\/payrollInstruction\/payrollProfileID StringType? -
- '\/payrollInstruction\/itemID StringType? -
- '\/payrollInstruction\/generalDeductionInstruction ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/itemID StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/longName StringType? -
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventmetaMetaDatatransforms![](/images/permalink.svg)
Fields
- itemID string? - The unique identifier of the collection.
- '\/eventReasonCode StringCodeListType? -
- '\/eventReasonCode\/codeValue StringType? -
- '\/eventReasonCode\/shortName StringType? -
- '\/eventReasonCode\/longName StringType? -
- '\/eventStatusCode StringCodeListType? -
- '\/eventStatusCode\/codeValue StringType? -
- '\/eventStatusCode\/shortName StringType? -
- '\/eventStatusCode\/longName StringType? -
- '\/effectiveDateTime StringType? -
- '\/notificationIndicator BooleanType? -
- '\/payrollInstruction ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/rateValue NumberType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/currencyCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/longName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/longName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseMultiplierValue NumberType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalStartDate StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount\/amountValue AmountValueType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount\/currencyCode StringCodeListType? -
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionchangeeventOnbehalfofparty![](/images/permalink.svg)
The party (client employee) that the actor is acting on behalf of to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) and can take action on that person's behalf. The Actor may have access to certain features or screens that the Client Employee cannot view, e.g. diagnostics screens.
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
- assignedGroups AssignedGroup[]? - An event instance
- organizationOID string? - A unique identifier of a client employee's organization id
adp.workerpayrollinstructions: WorkergeneralDeductionInstructionchangeQueryCriterion![](/images/permalink.svg)
A single query parameter
Fields
- queryOptionCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- obligationCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- queryOptionTypeCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- defaultNumberValue decimal? - The default number value
- defaultStringValue string? - The default string value
- resourcePathMax int? - Maximum number of resource paths supported
- pattern string? - Indicates a regular expression on the required pattern for the value
- resourcePaths string[]? - A collection of acceptable resource paths to pass to the query option
- excludedResourcePaths string[]? - A collection of resource paths which may not be passed to the query option. An example use of this is where you allow all paths except 1 or 2. You would want to only specify those which are excluded
- queryValueCodeList CodelisttypeV03? - A reference to the codeList which returns the possible values for the query option
- logicalOperators WorkergeneraldeductioninstructionstarteventmetaMetaLogicaloperators[]? - A collection of logical operators
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionStartEvent![](/images/permalink.svg)
Fields
- meta WorkergeneraldeductioninstructionstarteventMeta? - Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
- confirmMessage WorkergeneraldeductioninstructionstarteventConfirmmessage? - The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventActasparty![](/images/permalink.svg)
The party (client employee) information that the actor is acting as to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) in read only mode.
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
- organizationOID string? - A unique identifier of a client employee's organization id
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventActor![](/images/permalink.svg)
The actor is the party that completed the recording of the event
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventActorApplicationid![](/images/permalink.svg)
The unique identifier of the application which originated the event.
Fields
- idValue string? - An actual ID value
- schemeCode WorkergeneraldeductioninstructionstarteventOriginatorApplicationidSchemecode? - The scheme code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventActorGeocoordinate![](/images/permalink.svg)
The coordinates of the location of the actor
Fields
- latitude decimal? - The angle, in degrees, of a position on Earth above the equator. (Latitude is negative for a place below the equator.) specified in decimal degrees
- longitude decimal? - The angle, in degrees, of a position on Earth around the equator from the Greenwich Meridian specified in decimal degrees
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessage![](/images/permalink.svg)
The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
Fields
- confirmMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageConfirmmessageid? - An identifier for the instance of the confirm message.
- createDateTime string? - The date & time that the message instance was generated.; follows the ISO-8601:2000 format: 2008-05-11T15:30:00-06:00.
- requestReceiptDateTime string? - The date & time that the request submitted by the client was received. Note, this timestamp may not be the same as the time the client actually submitted the request if there is a queuing mechanism between the client and server processing the request; it follows the ISO-8601:2000 format: 2008-05-11T15:30:00-06:00.
- protocolStatusCode WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolstatuscode? - Protocol-specific response status code.
- protocolCode WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolcode? - Code that identifies the protocol used for the request.
- requestID WorkergeneraldeductioninstructionstarteventConfirmmessageRequestid? - The identifier of the request that generated this response.
- requestStatusCode ConfirmmessagetypeV01Requeststatuscode? - The process results status code for the request.
- requestMethodCode ConfirmmessagetypeV01Requestmethodcode? - The method that was used on the request corresponding to this message instance.
- sessionID WorkergeneraldeductioninstructionstarteventConfirmmessageSessionid? - A session identifier if one is available.
- requestETag string? - The entity tag of the entity in the request.
- requestLink WorkergeneraldeductioninstructionstarteventConfirmmessageRequestlink? - The link of the request that generated this response.
- processingStatusCode ConfirmmessagetypeV01Processingstatuscode? - Processing status of the related request message.
- processMessages WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessages[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
- resourceMessages WorkergeneraldeductioninstructionstarteventConfirmmessageResourcemessages[]? - resource Message contains the resource-specific processing results for resources being managed in the request. A resource may have its processing reported as: succeeded or failed. It must be used to represent resource-specific messages. In the case of a request managing multiple resources and resource-specific messages are to be returned, then this array will contain one object for each such resource of the request.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageConfirmmessageid![](/images/permalink.svg)
An identifier for the instance of the confirm message.
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageLinks1![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageMessagetypecode![](/images/permalink.svg)
Process Message instances may be of type: success, warning, error, or info.
Fields
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
- codeValue string? - The code for the related entity.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessageid![](/images/permalink.svg)
An identifier for the instance of the process message.
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessages![](/images/permalink.svg)
Each object contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level).
Fields
- processMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageProcessmessageid? - An identifier for the instance of the process message.
- messageTypeCode WorkergeneraldeductioninstructionstarteventConfirmmessageMessagetypecode? - Process Message instances may be of type: success, warning, error, or info.
- sourceLocationExpression string? - Expression that provides the location (or source) of content in a message instance that is associated with a process message. Examples of expression languages include: XPath, XQuery, JSON Pointer.
- expressionLanguageCode ConfirmmessagetypeV01Expressionlanguagecode? - Identifies the language used for expressions communicated in this message.
- links WorkergeneraldeductioninstructionstarteventConfirmmessageLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
- userMessage WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessage? - Message returned to the user
- developerMessage WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessage? - Message returned to the user
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolcode![](/images/permalink.svg)
Code that identifies the protocol used for the request.
Fields
- codeValue string? - The code for the related entity.
- shortName string? - Short description of the related code not to exceed 25 characters
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageProtocolstatuscode![](/images/permalink.svg)
Protocol-specific response status code.
Fields
- codeValue string? - The code for the related entity.
- shortName string? - Short description of the related code not to exceed 25 characters
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageRequestid![](/images/permalink.svg)
The identifier of the request that generated this response.
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageRequestlink![](/images/permalink.svg)
The link of the request that generated this response.
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageResourcelink![](/images/permalink.svg)
The link of the request that generated this response.
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageResourcemessageid![](/images/permalink.svg)
An identifier for the instance of the resource message.
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageResourcemessages![](/images/permalink.svg)
Each object contains detailed information for a resource referenced in the original request.
Fields
- resourceMessageID WorkergeneraldeductioninstructionstarteventConfirmmessageResourcemessageid? - An identifier for the instance of the resource message.
- resourceStatusCode ResourceMessageResourceStatus? - The processing results status code of the resource of the request.
- resourceLink WorkergeneraldeductioninstructionstarteventConfirmmessageResourcelink? - The link of the request that generated this response.
- processMessages Processmessagewithresourcestatuscode1[]? - processMessage is optional and contains processing information for either the request (at the ConfirmMessage level) or a resource being managed in the request (at the ResourceMessage level). Most often there will be a single instance for an associated request or resource, but this structure allows for more than one if needed, for example, if multiple errors exist for a single resource.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageResourcestatuscode![](/images/permalink.svg)
DEPRECATED - Use messageTypeCode instead. The processing results status code of the resource of the request.
Fields
- codeValue string? - The code for the related entity.
- shortName string? - Short description of the related code not to exceed 25 characters
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageSessionid![](/images/permalink.svg)
A session identifier if one is available.
Fields
- idValue string? - An ID
- schemeName string? - The type of ID
- schemeAgencyName string? - The agency that issues the ID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessage![](/images/permalink.svg)
Message returned to the user
Fields
- codeValue string? - The code associated with the message description.
- title string? - Title of the message description.
- messageTxt string? - The value/content of the message description.
- links WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessageLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventConfirmmessageUsermessageLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventData![](/images/permalink.svg)
Event Data
Fields
- eventContext WorkergeneraldeductioninstructionstarteventDataEventcontext? - Data which sets the context for the event. That is, the keys which set context
- transform WorkergeneraldeductioninstructionstarteventDataTransform? - Data which is transformed as a result of the event
- output WorkergeneraldeductioninstructionstarteventDataOutput? - Result of the event
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataEventcontext![](/images/permalink.svg)
Data which sets the context for the event. That is, the keys which set context
Fields
- contextExpressionID string? - A globally unique (GUID) identifier of the context expression. This conveys the context of the associated data. For example, if the context is set to Germany, the data would adhere to the business rules and formatting rules relevant to Germany
- 'worker WorkergeneraldeductioninstructionstarteventDataEventcontextWorker? - Worker
- payrollInstruction PayrollInstructionEventContext? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataEventcontextWorker![](/images/permalink.svg)
Worker
Fields
- associateOID string? - A unique identifier of a covered individual when there is an AOID
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataOutput![](/images/permalink.svg)
Result of the event
Fields
- payrollInstruction PayrollInstructionOutput? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataTransform![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- eventReasonCode WorkergeneraldeductioninstructionstarteventDataTransformEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage vs. Divorce vs. Separation
- eventStatusCode WorkergeneraldeductioninstructionstarteventDataTransformEventstatuscode? - This identifies the status of the event. An event that has been created, either by the system of record or as the result of a user, will have an event status code of Created. An event that is saved in a work in progress state (as determined by the permissable state codes), will have an event status code of InProgress. An event that has been recorded, will have an event status code of Complete. This value is set by the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
- payrollInstruction PayrollInstructionTransform? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataTransformEventreasoncode![](/images/permalink.svg)
This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage vs. Divorce vs. Separation
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventDataTransformEventstatuscode![](/images/permalink.svg)
This identifies the status of the event. An event that has been created, either by the system of record or as the result of a user, will have an event status code of Created. An event that is saved in a work in progress state (as determined by the permissable state codes), will have an event status code of InProgress. An event that has been recorded, will have an event status code of Complete. This value is set by the system of record
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventEventnamecode![](/images/permalink.svg)
This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventEventreasoncode![](/images/permalink.svg)
This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage or Divorce. This is optional and valued as defined by the system of record
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventEvents![](/images/permalink.svg)
An instance to capture the initiation of a general deduction.
Fields
- eventID string? - The unique identifier of the event instance. This is set by the system of record once an event is recorded as in progress or complete
- serviceCategoryCode WorkergeneraldeductioninstructionstarteventServicecategorycode? - The service domain, e.g. HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist
- eventNameCode WorkergeneraldeductioninstructionstarteventEventnamecode? - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist
- eventTitle string? - The event title offers a way to describe a particular instance of an event at a level more granular than the event name, e.g. 2014 Annual Enrollment
- eventSubTitle string? - The event sub title provides event instance summary details, e.g. All Annual Enrollment elections become effective on January 1, 2014
- eventReasonCode WorkergeneraldeductioninstructionstarteventEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage or Divorce. This is optional and valued as defined by the system of record
- eventStatusCode WorkergeneraldeductioninstructionstarteventEventstatuscode? - This identifies the status of the event. An event that has been initiated by the system of record will have an event status code of created. An event that is saved in a work in progress state will have an event status code of inProgress. An event that has been recorded will have an event status code of complete. These values are set by the system of record and valued based on a standard codeslist
- priorityCode WorkergeneraldeductioninstructionstarteventPrioritycode? - This allows the system of record to prioritize events and is valued based on a standard codelist
- recordDateTime string? - This is the date time the event is recorded in the system of record with an event status code equal to complete. This value is set by the system of record
- creationDateTime string? - This is the date time the event is created. If a system of record creates the event instance, as in the case of an annual enrollment for example, then is sets the creation date time. If a user declares an event, then this is set to the date time when the first call is made to the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
- expirationDateTime string? - This value is set by the system of record and used to term the life cycle of an event instance.
- dueDateTime string? - This value is set by the system of record and allows for the presentation of a date by which the system of record would like the user to complete the event
- originator WorkergeneraldeductioninstructionstarteventOriginator? - An originator is a user, machine or event that triggered the event
- actor WorkergeneraldeductioninstructionstarteventActor? - The actor is the party that completed the recording of the event
- actAsParty WorkergeneraldeductioninstructionstarteventActasparty? - The party (client employee) information that the actor is acting as to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) in read only mode.
- onBehalfOfParty WorkergeneraldeductioninstructionstarteventOnbehalfofparty? - The party (client employee) that the actor is acting on behalf of to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) and can take action on that person's behalf. The Actor may have access to certain features or screens that the Client Employee cannot view, e.g. diagnostics screens.
- links WorkergeneraldeductioninstructionstarteventLinks[]? - Links
- data WorkergeneraldeductioninstructionstarteventData? - Event Data
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventEventstatuscode![](/images/permalink.svg)
This identifies the status of the event. An event that has been initiated by the system of record will have an event status code of created. An event that is saved in a work in progress state will have an event status code of inProgress. An event that has been recorded will have an event status code of complete. These values are set by the system of record and valued based on a standard codeslist
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventMeta![](/images/permalink.svg)
Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
Fields
- startSequence int? - The instance resource sequence (number) identifying the first resource returned in the response. The server generates this sequence. It is used by the client to determine the start sequence of the subsequent Get request
- completeIndicator boolean? - Indicates whether the response completes the return of all of the resources of the instance resource set to the requesting system
- totalNumber int? - Number of total instance resources in an instance resource set. Note: An instance resource set is a set of instance resources that is determined by a server to satisfy the sets membership criteria (i.e., selection, filter, expansion and search criteria) of a resource management operation (e.g. GET request) upon a collection resource
- resourceSetID string? - Unique identifier of the instance resource set. It is generated by the server as a result of the original Get request
- links WorkergeneraldeductioninstructionstarteventMetaLinks[]? - A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionStartEventMeta![](/images/permalink.svg)
Fields
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventMetaLinks![](/images/permalink.svg)
A link description object is used to describe link relations. In the context of a schema, it defines the link relations of the instances of the schema, and can be parameterized by the instance values. The link description format can be used on its own in regular (non-schema documents), and use of this format can be declared by referencing the normative link description schema as the the schema for the data structure that uses the links
Fields
- href string? - The URI of the related entity
- rel string? - Indicates the nature of the relationship of the related resource to the resource that generated this representation
- title string? - This property defines a title for the link. The value must be a string. User agents MAY use this title when presenting the link to the user.
- targetSchema string? - This property is a schema that defines the expected structure of the JSON representation of the target of the link, if the target of the link is returned using JSON representation.
- mediaType string? - The media type that the linked resource will return (Response)
- method string? - The HTTP method code (HTTP Verb) traverse the link (GET, POST, PUT or DELETE)
- encType string? - If present, this property indicates a query media type format that the server supports for querying or posting to the collection of instances at the target resource. The query can be suffixed to the target URI to query the collection with property-based constraints on the resources that SHOULD be returned from the server or used to post data to the resource (depending on the method). (Request)
- schema string? - This property contains a schema which defines the acceptable structure of the submitted request. For a GET request, this schema would define the properties for the query string and for a POST request, this would define the body.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventmetaMeta![](/images/permalink.svg)
Fields
- '\/serviceCategoryCode\/codeValue string - The service domain, e.g HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist.
- '\/eventNameCode\/codeValue string - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist.
- queryCriteria WorkergeneralDeductionInstructionstartQueryCriterion[]? - A collection of query criteria
- '\/data\/eventContext WorkergeneraldeductioninstructionstarteventmetaMetaDataeventcontext? -
- '\/data\/transforms WorkergeneraldeductioninstructionstarteventmetaMetaDatatransforms[]? - A collection of transform rules
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventmetaMetaDataeventcontext![](/images/permalink.svg)
Fields
- '\/contextExpressionID StringType? -
- '\/worker ObjectType? -
- '\/worker\/associateOID StringType? -
- '\/payrollInstruction ObjectType? -
- '\/payrollInstruction\/payrollRegionCode StringCodeListType? -
- '\/payrollInstruction\/payrollRegionCode\/codeValue StringType? -
- '\/payrollInstruction\/payrollRegionCode\/shortName StringType? -
- '\/payrollInstruction\/payrollRegionCode\/longName StringType? -
- '\/payrollInstruction\/payrollGroupCode StringCodeListType? -
- '\/payrollInstruction\/payrollGroupCode\/codeValue StringType? -
- '\/payrollInstruction\/payrollGroupCode\/shortName StringType? -
- '\/payrollInstruction\/payrollGroupCode\/longName StringType? -
- '\/payrollInstruction\/payrollFileNumber StringType? -
- '\/payrollInstruction\/payrollProfileID StringType? -
- '\/payrollInstruction\/itemID StringType? -
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventmetaMetaDatatransforms![](/images/permalink.svg)
Fields
- itemID string? - The unique identifier of the collection.
- '\/eventReasonCode StringCodeListType? -
- '\/eventReasonCode\/codeValue StringType? -
- '\/eventReasonCode\/shortName StringType? -
- '\/eventReasonCode\/longName StringType? -
- '\/eventStatusCode StringCodeListType? -
- '\/eventStatusCode\/codeValue StringType? -
- '\/eventStatusCode\/shortName StringType? -
- '\/eventStatusCode\/longName StringType? -
- '\/effectiveDateTime StringType? -
- '\/notificationIndicator BooleanType? -
- '\/payrollInstruction ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionCode\/longName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/rateValue NumberType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/currencyCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/unitCode\/longName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/codeValue StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/shortName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseUnitCode\/longName StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionRate\/baseMultiplierValue NumberType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalStartDate StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount\/amountValue AmountValueType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalLimitAmount\/currencyCode StringCodeListType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalID StringType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalBalanceAmount ObjectType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalBalanceAmount\/amountValue AmountValueType? -
- '\/payrollInstruction\/generalDeductionInstruction\/deductionGoal\/goalBalanceAmount\/currencyCode StringCodeListType? -
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventmetaMetaLogicaloperators![](/images/permalink.svg)
A logical operation
Fields
- logicalOperatorCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- mutuallyExclusiveIndicator IndicatortypeV01? - Boolean expression
- mutuallyExclusiveLogicalOperatorCodes SimplecodetypeV02[]? - A list of mutually exclusive operator codes.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventOnbehalfofparty![](/images/permalink.svg)
The party (client employee) that the actor is acting on behalf of to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) and can take action on that person's behalf. The Actor may have access to certain features or screens that the Client Employee cannot view, e.g. diagnostics screens.
Fields
- applicationID WorkergeneraldeductioninstructionstarteventActorApplicationid? - The unique identifier of the application which originated the event.
- associateOID string? - The unique identifier of an associate who originated the event or a process
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the actor
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam.
- geoCoordinate WorkergeneraldeductioninstructionstarteventActorGeocoordinate? - The coordinates of the location of the actor
- deviceUserAgentID string? - Identifier of the user agent of the device used by the actor who worked on the event or process
- organizationOID string? - A unique identifier of a client employee's organization id
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventOriginator![](/images/permalink.svg)
An originator is a user, machine or event that triggered the event
Fields
- applicationID WorkergeneraldeductioninstructionstarteventOriginatorApplicationid? - The unique identifier of the application which originated the event or a process
- associateOID string? - The unique identifier of an associate who originated the event.
- personOID string? - The unique identifier of a person who originated the event or a process
- formattedName string? - Human readable name of the event originator
- eventID string? - The unique identifier of the event instance. This is generated once an event is recorded with an event status code equal to Complete. This value is set by the system of record.
- eventNameCode WorkergeneraldeductioninstructionstarteventOriginatorEventnamecode? - This is the canonical name of the event, e.g. dependent.add, worker.hire
- deviceID string? - The unique identifier of the device, e.g. a time clock, door entry beam
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventOriginatorApplicationid![](/images/permalink.svg)
The unique identifier of the application which originated the event or a process
Fields
- idValue string? - An actual ID value
- schemeCode WorkergeneraldeductioninstructionstarteventOriginatorApplicationidSchemecode? - The scheme code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventOriginatorApplicationidSchemecode![](/images/permalink.svg)
The scheme code
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventOriginatorEventnamecode![](/images/permalink.svg)
This is the canonical name of the event, e.g. dependent.add, worker.hire
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventPrioritycode![](/images/permalink.svg)
This allows the system of record to prioritize events and is valued based on a standard codelist
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstarteventServicecategorycode![](/images/permalink.svg)
The service domain, e.g. HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist
Fields
- codeValue string? - The code for the related entity
- shortName string? - Short description of the related code
- longName string? - Long description of the related code
adp.workerpayrollinstructions: WorkergeneralDeductionInstructionstartQueryCriterion![](/images/permalink.svg)
A single query parameter
Fields
- queryOptionCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- obligationCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- queryOptionTypeCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- defaultNumberValue decimal? - The default number value
- defaultStringValue string? - The default string value
- resourcePathMax int? - Maximum number of resource paths supported
- pattern string? - Indicates a regular expression on the required pattern for the value
- resourcePaths string[]? - A collection of acceptable resource paths to pass to the query option
- excludedResourcePaths string[]? - A collection of resource paths which may not be passed to the query option. An example use of this is where you allow all paths except 1 or 2. You would want to only specify those which are excluded
- queryValueCodeList CodelisttypeV03? - A reference to the codeList which returns the possible values for the query option
- logicalOperators WorkergeneraldeductioninstructionstarteventmetaMetaLogicaloperators[]? - A collection of logical operators
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionStopEvent![](/images/permalink.svg)
Fields
- events WorkergeneraldeductioninstructionstopeventEvents[]? -
- meta WorkergeneraldeductioninstructionstarteventMeta? - Meta contains the metadata associated with a response. A GET response may include metadata to support pagination
- confirmMessage WorkergeneraldeductioninstructionstarteventConfirmmessage? - The ConfirmMessage contains the processing results for the corresponding request. A request may have its processing reported as: succeeded, partially failed, or failed.
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventData![](/images/permalink.svg)
Event Data
Fields
- eventContext WorkergeneraldeductioninstructionstopeventDataEventcontext? - Data which sets the context for the event. That is, the keys which set context
- transform WorkergeneraldeductioninstructionstopeventDataTransform? - Data which is transformed as a result of the event
- output WorkergeneraldeductioninstructionstarteventDataOutput? - Result of the event
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventDataEventcontext![](/images/permalink.svg)
Data which sets the context for the event. That is, the keys which set context
Fields
- contextExpressionID string? - A globally unique (GUID) identifier of the context expression. This conveys the context of the associated data. For example, if the context is set to Germany, the data would adhere to the business rules and formatting rules relevant to Germany
- 'worker WorkergeneraldeductioninstructionstarteventDataEventcontextWorker? - Worker
- payrollInstruction Payrollinstructioneventcontext2? - Payroll instruction
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventDataTransform![](/images/permalink.svg)
Data which is transformed as a result of the event
Fields
- eventReasonCode WorkergeneraldeductioninstructionstarteventDataTransformEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage vs. Divorce vs. Separation
- eventStatusCode WorkergeneraldeductioninstructionstarteventDataTransformEventstatuscode? - This identifies the status of the event. An event that has been created, either by the system of record or as the result of a user, will have an event status code of Created. An event that is saved in a work in progress state (as determined by the permissable state codes), will have an event status code of InProgress. An event that has been recorded, will have an event status code of Complete. This value is set by the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventEvents![](/images/permalink.svg)
An instance to capture the ending of a general deduction.
Fields
- eventID string? - The unique identifier of the event instance. This is set by the system of record once an event is recorded as in progress or complete
- serviceCategoryCode WorkergeneraldeductioninstructionstarteventServicecategorycode? - The service domain, e.g. HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist
- eventNameCode WorkergeneraldeductioninstructionstarteventEventnamecode? - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist
- eventTitle string? - The event title offers a way to describe a particular instance of an event at a level more granular than the event name, e.g. 2014 Annual Enrollment
- eventSubTitle string? - The event sub title provides event instance summary details, e.g. All Annual Enrollment elections become effective on January 1, 2014
- eventReasonCode WorkergeneraldeductioninstructionstarteventEventreasoncode? - This allows for further refinement of the associated event. For example, for a worker.maritalStatus.change event, the reason code could be used to describe whether it is a Marriage or Divorce. This is optional and valued as defined by the system of record
- eventStatusCode WorkergeneraldeductioninstructionstarteventEventstatuscode? - This identifies the status of the event. An event that has been initiated by the system of record will have an event status code of created. An event that is saved in a work in progress state will have an event status code of inProgress. An event that has been recorded will have an event status code of complete. These values are set by the system of record and valued based on a standard codeslist
- priorityCode WorkergeneraldeductioninstructionstarteventPrioritycode? - This allows the system of record to prioritize events and is valued based on a standard codelist
- recordDateTime string? - This is the date time the event is recorded in the system of record with an event status code equal to complete. This value is set by the system of record
- creationDateTime string? - This is the date time the event is created. If a system of record creates the event instance, as in the case of an annual enrollment for example, then is sets the creation date time. If a user declares an event, then this is set to the date time when the first call is made to the system of record
- effectiveDateTime string? - This is the effective date, or effective date time fo the event from a business perspective. In some systems, this may be referred to as the Event Date. For example, for a birth event, this is the date of birth. If there is no effective date from a business perspective, this is set equal to the record date time
- expirationDateTime string? - This value is set by the system of record and used to term the life cycle of an event instance.
- dueDateTime string? - This value is set by the system of record and allows for the presentation of a date by which the system of record would like the user to complete the event
- originator WorkergeneraldeductioninstructionstarteventOriginator? - An originator is a user, machine or event that triggered the event
- actor WorkergeneraldeductioninstructionstarteventActor? - The actor is the party that completed the recording of the event
- actAsParty WorkergeneraldeductioninstructionstarteventActasparty? - The party (client employee) information that the actor is acting as to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) in read only mode.
- onBehalfOfParty WorkergeneraldeductioninstructionstarteventOnbehalfofparty? - The party (client employee) that the actor is acting on behalf of to complete the recording of the event. Example: An ADP Support User (principal A = Actor) views data within an ADP Application as a client employee (principal B) and can take action on that person's behalf. The Actor may have access to certain features or screens that the Client Employee cannot view, e.g. diagnostics screens.
- links WorkergeneraldeductioninstructionstarteventLinks[]? - Links
- data WorkergeneraldeductioninstructionstopeventData? - Event Data
adp.workerpayrollinstructions: WorkerGeneralDeductionInstructionStopEventMeta![](/images/permalink.svg)
Fields
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventmetaMeta![](/images/permalink.svg)
Fields
- '\/serviceCategoryCode\/codeValue string - The service domain, e.g HR, Payroll, Benefits, etc. This field is always present and valued based on a standard codelist.
- '\/eventNameCode\/codeValue string - This is the canonical name of the event, e.g. dependent.add, worker.hire. This field is always present and valued based on a standard codelist.
- queryCriteria WorkergeneralDeductionInstructionstopQueryCriterion[]? - A collection of query criteria
- '\/data\/eventContext WorkergeneraldeductioninstructionchangeeventmetaMetaDataeventcontext? -
- '\/data\/transforms WorkergeneraldeductioninstructionstopeventmetaMetaDatatransforms[]? - A collection of transform rules
adp.workerpayrollinstructions: WorkergeneraldeductioninstructionstopeventmetaMetaDatatransforms![](/images/permalink.svg)
Fields
- itemID string? - The unique identifier of the collection.
- '\/eventReasonCode StringCodeListType? -
- '\/eventReasonCode\/codeValue StringType? -
- '\/eventReasonCode\/shortName StringType? -
- '\/eventReasonCode\/longName StringType? -
- '\/eventStatusCode StringCodeListType? -
- '\/eventStatusCode\/codeValue StringType? -
- '\/eventStatusCode\/shortName StringType? -
- '\/eventStatusCode\/longName StringType? -
- '\/effectiveDateTime StringType? -
- '\/notificationIndicator BooleanType? -
adp.workerpayrollinstructions: WorkergeneralDeductionInstructionstopQueryCriterion![](/images/permalink.svg)
A single query parameter
Fields
- queryOptionCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- obligationCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- queryOptionTypeCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- defaultNumberValue decimal? - The default number value
- defaultStringValue string? - The default string value
- resourcePathMax int? - Maximum number of resource paths supported
- pattern string? - Indicates a regular expression on the required pattern for the value
- resourcePaths string[]? - A collection of acceptable resource paths to pass to the query option
- excludedResourcePaths string[]? - A collection of resource paths which may not be passed to the query option. An example use of this is where you allow all paths except 1 or 2. You would want to only specify those which are excluded
- queryValueCodeList CodelisttypeV03? - A reference to the codeList which returns the possible values for the query option
- logicalOperators WorkergeneraldeductioninstructionstarteventmetaMetaLogicaloperators[]? - A collection of logical operators
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
adp.workerpayrollinstructions: WorkerLienOutput![](/images/permalink.svg)
Worker lien
Fields
- lienDocumentID SimpleidtypeV02? - The simple (string) identifier of an object
- lienStatusCode StatustypeV02? - Status to include the status code and effective date (ISO-8601:2000 format)
- lienIssuanceDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- lienRegistrationDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- lienMaritalStatusCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- allowanceQuantity int? - The number of employee's exemptions claimed
- additionalAllowanceQuantity int? - Additional exemptions, caused by the certification,.e.g. 'Blind' or 'Over 65'
- lienNumber int? - The sequential number of the lien for a given worker
- lienTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- lienSubTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- lienReturnDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- courtOrder WorkerlienoutputCourtorder? - The court order the lien is based on
- medicalInsuranceOfferedIndicator IndicatortypeV01? - Boolean expression
- fundsDisbursement WorkerlienoutputFundsdisbursement? - Lien funds disbursement information necessary for garnishment processing for payroll
- lienExemptAmount AmounttypeV02? - A representation of a monetary value
- disposableWagesAmount AmounttypeV02? - A representation of a monetary value
- stateServiceChargeAmount AmounttypeV02? - A representation of a monetary value
- fullServiceClientIndicator IndicatortypeV01? - Boolean expression
- itemID ItemidtypeV01? - The unique identifier of the object in a collection
- lienTotalAccumulatedAmount AmounttypeV02? - A representation of a monetary value
adp.workerpayrollinstructions: WorkerlienoutputCourtorder![](/images/permalink.svg)
The court order the lien is based on
Fields
- orderID IdtypeV02? - The unique identifier of the related entity
- supportTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- caseNumber SimpleidtypeV02? - The simple (string) identifier of an object
- courtName string? - The court name that issued the lien
- issuingJurisdiction WorkerlienoutputCourtorderIssuingjurisdiction? - The jurisdiction that issued the lien
- FIPSCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- multipleSupportOrderIndicator IndicatortypeV01? - Boolean expression
- executionNumber SimpleidtypeV02? - The simple (string) identifier of an object
- supportOrderInArrearsIndicator IndicatortypeV01? - Boolean expression
- orderReleaseIndicator IndicatortypeV01? - Boolean expression
- orderReleaseDate DatetypeV01? - The string representation of the date value. Follows the ISO-8601:2000 format
- orderIndexOnlyIndicator IndicatortypeV01? - Boolean expression
adp.workerpayrollinstructions: WorkerlienoutputCourtorderIssuingjurisdiction![](/images/permalink.svg)
The jurisdiction that issued the lien
Fields
- cityName string? - A city in the context of an address
- countrySubdivisionLevel1 CountrysubdivisiontypeV02? - A country sub-division correlating to a administrative level one or two levels below country. For example, in the United States, this might be a state or a county
- countrySubdivisionLevel2 CountrysubdivisiontypeV02? - A country sub-division correlating to a administrative level one or two levels below country. For example, in the United States, this might be a state or a county
- postalCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- countryCode SimplecodetypeV02? - A simple (string) code. Can have a code list reference
- jurisdictionCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- jurisdictionTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
adp.workerpayrollinstructions: WorkerlienoutputFundsdisbursement![](/images/permalink.svg)
Lien funds disbursement information necessary for garnishment processing for payroll
Fields
- payee PartytypeV02? - Object describing the details of a party, either person or organization
- obligee PartytypeV02? - Object describing the details of a party, either person or organization
- paymentToPayeeIndicator IndicatortypeV01? - Boolean expression
- paymentSchedule PaymentScheduleLienFundsDisbursement? - Denotes when payment should be remitted
- disbursementFees FeetypeV02[]? - A list of any disbursement fees
- disbursementMessages WorkerlienoutputFundsdisbursementDisbursementmessages[]? - A message related to the disbursement, e.g. a message on the check
- paymentMethodCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- depositAccount DepositaccounttypeV02? - Bank account info
- lumpSumWithholdingIndicator IndicatortypeV01? - Boolean expression
adp.workerpayrollinstructions: WorkerlienoutputFundsdisbursementDisbursementmessages![](/images/permalink.svg)
Fields
- textValue string? - The text entered by the user
- messageTypeCode CodetypeV02? - The code for the related entity. If this is a coded value, codeValue and shortName should be used. If this is just a string value, only shortName is necessary
- showOnCheckIndicator IndicatortypeV01? - Boolean expression
String types![](/images/permalink.svg)
adp.workerpayrollinstructions: DatetimetypeV01![](/images/permalink.svg)
DatetimetypeV01
The string reprersentation of the date-time value. Follows the ISO-8601:2000 format
adp.workerpayrollinstructions: DatetypeV01![](/images/permalink.svg)
DatetypeV01
The string representation of the date value. Follows the ISO-8601:2000 format
adp.workerpayrollinstructions: EmailuritypeV02![](/images/permalink.svg)
EmailuritypeV02
The email URI of the related entity
adp.workerpayrollinstructions: HttpMethodType![](/images/permalink.svg)
HttpMethodType
Simple (string) code identifying the http method used to invoke the API
adp.workerpayrollinstructions: ItemIDType![](/images/permalink.svg)
ItemIDType
A unique identifier of an object within the collection
adp.workerpayrollinstructions: ItemidtypeV01![](/images/permalink.svg)
ItemidtypeV01
The unique identifier of the object in a collection
adp.workerpayrollinstructions: MetaDataType![](/images/permalink.svg)
MetaDataType
adp.workerpayrollinstructions: SimplecodetypeV02![](/images/permalink.svg)
SimplecodetypeV02
A simple (string) code. Can have a code list reference
adp.workerpayrollinstructions: SimpleIDType![](/images/permalink.svg)
SimpleIDType
adp.workerpayrollinstructions: SimpleidtypeV02![](/images/permalink.svg)
SimpleidtypeV02
The simple (string) identifier of an object
adp.workerpayrollinstructions: UriType![](/images/permalink.svg)
UriType
URI type
adp.workerpayrollinstructions: UritypeV01![](/images/permalink.svg)
UritypeV01
The URI of the related entity
Integer types![](/images/permalink.svg)
adp.workerpayrollinstructions: SequenceType![](/images/permalink.svg)
SequenceType
A number which provides the sequence that this property should be presented in relation to other properties.
adp.workerpayrollinstructions: SequencetypeV01![](/images/permalink.svg)
SequencetypeV01
Sequence of a related entity when included in the collection or a group
Import
import ballerinax/adp.workerpayrollinstructions;
Metadata
Released date: over 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Human Resources/HRMS
Cost/Paid
Contributors
Dependencies