Integrating with PeopleSoft Pension Administration
This topic covers Integration Broker messaging between PeopleSoft Pension Administration and PeopleSoft Receivables.
One Integration Broker service operation facilitates the communication between Pension Administration and Receivables. The PA_SP_MSG record is added to define the message structure, and it will be referenced by the new message. The message data will be populated differently for each event.
Messages from Pension Administration to Receivables include the following:
Create Open Item
Pension Administration sends a message to create open invoices in AR to track the payment of lump sum or installment payments for the cost of the Service Purchase. One message will be sent for each open item to be created.
Service Purchase Canceled
Pension Administration sends a message to create credit items in Receivables. This kind of message can be used for two purposes:
To change the Tax Type (Pre-tax/Post-tax) of a Service Purchase item.
To cancel the entire Service Purchase transaction. In this case, the system creates credit items to match all the Service Purchase items still open in Receivables.
See Canceling or Refunding Payments for Service Purchase Items.
Service Purchase Refund Requested
Pension Administration sends a message to Receivables indicating that a refund of all payments to date has been requested due to cancellation of a service purchase transaction.
Messages from Receivables to Pension Administration include the following:
Response to Creating Open Items, Refund, or Cancellation
Receivables sends a message to Pension Administration to indicate success or that an error occurred when creating pending items, credits for refund, or credits for cancellation. This message occurs soon after the validation step. The validation step happens automatically when Receivables receives the Integration Broker message.
When the groups of pending items or the groups of credit items are posted, Receivables sends another message communicating this action as well.
Payments
Receivables sends a message to Pension Administration to indicate payment has been applied to an open item in AR.
Goal Balance Reached
Receivables sends a message to Pension Administration to indicate that all open items have been closed. This message is generated when the last open Service Purchase Item has been paid.
Reversal
Receivables sends a message to Pension Administration to indicate an open item has been reopened due to failure of payment at the bank. Pension Administration will perform a reversal of that payment. This may also be sent if a payment is unposted in Receivables.
The following table lists the fields that compose the messages:
Field |
Message Description |
---|---|
5 - Business Unit |
The Receivables Business Unit in which the items will be created. Because Pension Administration is a U.S.-only application, the business unit must be a U.S. business unit. |
1 - Emplid |
Information received from Pension Administration. Customer ID has a hidden field that contains the Emplid. The emplid of the message should match the emplid of the customer. |
3 - Benefit Plan |
Information received from Pension Administration. Used by Pension Administration for tracking. |
2 - Customer ID |
The Pension Administration employee should be previously established as a customer in the financials database. The SetID for this customer will be determined in Receivables by Table Set Control. |
8 - Due Date |
Pension Administration must provide a Due Date. |
9 - Entry Type |
Pension Administration must provide an Entry Type. The Entry Type together with the Entry Reason contains the account and Chartfields that should be used for accounting in Receivables. When the request is to create a Debit Pending Item, proper Entry Type for Debit should be provided. When the request is to create Credit Items for Cancellation of Refund, Entry Type for Credit should be provided. The SetID for the Entry Type will be determined in Receivables by Table Set Control. |
10 - Entry Reason |
In combination with the Entry Type, an Entry Reason is needed to determine Account and Chartfields information. |
12 - Amount |
The invoice amount. Even for Credit items, a positive amount should be provided in this field. |
13 - Currency |
Pension Administration is a U.S.-only product, which means that the currency is USD. The business unit is also a U.S. BU. |
14 - Accounting Date |
Pension Administration provides the accounting date. |
6 - Installment Number |
Number of the installment sent by Pension Administration. When Receivables send IB messages to communicate payments and cancellations over a service purchase item, the installment number of this item is always included in the message. When Pension Administration sends Cancellation messages to cancel a specific Service Purchase item, this field can be populated with the installment number of the item intended to be canceled. However no validation is done in Receivables to assure that credits and debits are matched only when they have corresponding Installment Numbers. |
11 - Tax Type |
This value indicates whether this is a pre-tax or a post-tax amount. Pension Administration sends the appropriate Entry Type and Entry Reason to enable accounting entries to be added to the appropriate Pre-Tax or Post-Tax accounts. |
4 - Service Purchase ID |
Pension Administration assigns the Service Purchase ID (SP_ID). The SP_ID is assigned to the set of invoices that will be created by the set of messages triggered from Pension Administration. The SP_ID will also be stamped in the Credit Items created from messages coming from Pension Administration. |
7 - Message Number from Pension |
Pension Administration creates a message number that is populated for each message that Pension sends to Receivables requesting the creation of a Debit or Credit Memo. When Receivables replies to this message regarding Validation errors, successful creation of the pending item groups, successful posting of pending item groups, or any other activity that Receivables communicates regarding Service Purchase items, this Message Number should be populated with the same value originally sent by Pension. Pension Administration uses this field, together with the Installment number, to track the items created in Receivables. If a validation error occurred, Pension will send another IB message after fixing the issue; the new message will have the same Message Number as the original one that failed. |
15 - Source System |
AR - PeopleSoft Receivables sends message to PeopleSoft Pension Administration PA - PeopleSoft Pension Administration sends message to PeopleSoft Receivables |
16 - Request Code |
CRT - Create Open Item PAY – Pay an Item CNL - Cancel Item RFD – Refund REV - Reversal of Payment GBA – Goal Balance Attained |
17 - Request Status |
01 – Request 02 - Success - Pending 03 - Success - Item 04 - Error 05 – Resend 06 – Applied |
18 - Message Code for the Validation Error found |
Receivables will create the pending item only after it validates all the fields to ensure that Receivables Update will not find any error during posting. If an error is detected, the message code is populated in this field so that Pension Administration will know what is wrong in the setup and will be able to fix it or to communicate with the Receivables person to have it fixed. |
CF SubRecord |
This field will be present in the message record in the HCM database. It will not be present in the FSCM database because Receivables does not use any account or CF SubRecord received by Pension. Rather, this information comes from the Entry Type/Entry Reason and current Receivables setup. Pension Administration can use CF SubRecord to integrate with third-party Receivables systems outside of PeopleSoft. |
This table describes how the Request Code and the Request Status determine integration actions:
Action |
Sent By |
Request Code |
Request Status |
---|---|---|---|
Request creation of Debit Memo |
Pension Administration |
CRT |
01 - Request |
Receivables validation ok |
Receivables |
CRT |
02 - Success-Pending |
Receivables validation failed |
Receivables |
CRT |
04 - Error |
Pension Administration resends a message |
Pension Administration |
CRT |
05 - Resend |
Receivables posts pending item with success |
Receivables |
CRT |
03 - Success-Item |
Payment Received |
Receivables |
PAY |
06 – Applied |
Unpost |
Receivables |
REV |
06 – Applied |
Request creation of Credit Memo for Refund |
Pension |
RFD |
01 - Request |
Receivables validation of Credit Memo for Refund is ok |
Receivables |
RFD |
02 - Success-Pending |
Receivables validation of Credit Memo for Refund failed |
Receivables |
RFD |
04 - Error |
Pension Administration sends or resends a message for creation of Credit Memo for Refund |
Pension Administration |
RFD |
05 - Resend |
Receivables posts the Credit Memo for Refund |
Receivables |
RFD |
03 - Success-Item |
Credit Memo has been refunded and posted successfully |
Receivables |
RFD |
06 – Applied |
Request creation of Credit Memo for Cancellation |
Pension Administration |
CNL |
01 - Request |
Receivables validation for Credit Memo for Cancellation is ok |
Receivables |
CNL |
02 - Success-Pending |
Receivables validation for Credit Memo for Cancellation failed |
Receivables |
CNL |
04 - Error |
Pension Administration resends a message for creation of Credit Memo for Cancellation |
Pension |
CNL |
05 - Resend |
Receivables posts the Credit Memo for Cancellation |
Receivables |
CNL |
03 - Success-Item |
Credit Memo has been used for Cancel Open Items and has been successfully posted |
Receivables |
CNL |
06 - Applied |
Open Items have been matched against the Credit Memo for cancellation. |
Receivables |
CNL |
06 - Applied |
Goal Balance attained. |
Receivables |
GBA |
06 - Applied |
Most of the validations performed for Pension Administration are validations that Receivables Update uses to post the invoices. Receivables should only create pending items if those pending items are guaranteed to pass all Receivables Update validations.
Receivables cannot validate accounting entries when the message is received, which might generate an error message when Receivables Update processes the group. In this case the group will appear in the External Item Error Correction component and cannot be edited. Users must delete all of the accounting entries to correct this error, fix the setup that caused the error, set the group to Batch Standard, and run Receivables Update again.
Message Set |
Message Number |
Pension Error Code |
Message |
Action Required |
---|---|---|---|---|
6031 |
1 |
1 |
Business Unit Invalid |
Verify that the business unit used for the Pending Item has been created in AR and GL. |
6035 |
102 |
2 |
Customer does not exist. |
Verify that the customer exists on the Customer General Information page. Confirm that the customer status is Active and the customer level is not set to Prospect. Also verify that the Bill to Customer check box is selected on the Bill to Customer Selection page. |
6031 |
2 |
3 |
Customer Options Missing |
Verify that Customer Options have been defined, are active, and are properly effective dated for this customer and accounting date. |
6031 |
3 |
4 |
Entry Type/Entry Reason is not valid. |
Verify the status of the Entry Type/Entry Reason on the Entry Type page. |
6030 |
38 |
5 |
Entry Reason required. |
This Entry Type requires an Entry Reason. Enter an Entry Reason or deselect the Required Reason check box on the Item Entry Type selection or Automatic Entry Type selection page. |
6035 |
302 |
6 |
AR Distribution code Invalid. |
Verify the status of the Distribution Code on the Distribution Code page. |
6030 |
33 |
7 |
Entry Type and Entry amount combination is invalid. |
Verify the entry amount for this Entry Type. Entry types require either positive or negative amounts based on the Entry Type. |
6030 |
34 |
7 |
Entry Type and Entry amount combination is invalid. |
Verify the entry amount for this Entry Type. Entry types require either positive or negative amounts based on the Entry Type. |
6031 |
4 |
8 |
Subcustomer is not valid for Service Purchase Integration. |
Change Customer or deselect the Subcustomer check box on the Customer General Information page. |
6031 |
5 |
9 |
Customer IPAC flag is not valid for Service Purchase Integration. |
Change Customer or deselect the IPAC check box on the Customer General Information page. |
6035 |
601 |
10 |
Entry Currency is not valid. |
Entry Currency Code must be active based on the pending item accounting date. Verify the status and effective date on the Currency Code page. |
9000 |
302 |
11 |
Accounting Period Not Open |
Verify in General Ledger that the accounting period is open for the transaction type specified on the Group Type page. See transaction type for Group Type being posted. |
6035 |
22 |
12 |
Direct Debit Profile Missing |
Pending Item has a Payment Method of Direct Debit but is missing a Direct Debit Profile. Verify that a profile for the customer has been defined on the Customer General Information Payment Option page. |
6035 |
33 |
13 |
Direct Debit Profile Invalid |
Pending Item has a Payment Method of Direct Debit, but the Direct Debit Profile indicated is invalid. Either add this Direct Debit profile to the Direct Debit Profile table or change the indicated Direct Debit Profile to a valid value. |
6031 |
6 |
14 |
At least one account to be used for the accounting entries is Inactive. |
Verify the accounts for the Entry Type / Entry Reason on the Item Entry Type page. |
6030 |
58 |
15 |
Due Date is required. |
Verify the Due Date in the Pension message. |
6035 |
202 |
16 |
Collector Invalid |
Verify the status and effective date of the collector on the Collector page. |
6035 |
201 |
17 |
Credit Analyst Invalid |
Verify the status and effective date of the credit analyst on the Credit Analyst page. |
6035 |
200 |
18 |
Salesperson Invalid |
Verify that the default Support Team defined for this customer has a Team Member defined as a Salesperson with a priority greater than zero. |
6031 |
7 |
19 |
Group Type is not valid. |
Verify the default Pension Group Type for SetID on the Receivables Options page. |
6030 |
202 |
20 |
The AR Distribution Code is a required field. |
Verify the default Distribution Code for Entry Type / Customer / Business Unit. |
6030 |
44 |
21 |
You must complete the subcustomer information. |
Verify the Subcustomer setup on the Customer Information pages. |
6030 |
132 |
22 |
Due Date cannot be less than Accounting Date. |
Verify the Due Date and Accounting Date in the Pension message. |
13 |
10 |
23 |
There is no matching conversion rate for the currency pair. |
Verify the Market Rate for the Currency Code to Base Currency conversion. |
6030 |
35 |
24 |
You must enter exchange rate information. |
Verify the Market Rate for the Currency Code to Base Currency conversion. |
6030 |
73 |
25 |
Payment Method is not defined. |
Verify the default Payment Method for the Customer / Business Unit. |
6031 |
8 |
26 |
Draft Type is invalid. |
Service Purchase invoices could not use Payment Method Draft. Verify Payment Method default on the Customer page. |
6031 |
9 |
27 |
Draft Approval is invalid. |
Service Purchase invoices could not use Payment Method Draft. Verify Payment Method default on the Customer page. |
6031 |
10 |
28 |
Draft Document is invalid. |
Service Purchase invoices could not use Payment Method Draft. Verify Payment Method default on the Customer page. |
6031 |
11 |
29 |
The Group Type associated with this transaction does not have an associated Document Type. |
Document Sequencing is active. Define a Document Type on the Group Type page. |
6031 |
13 |
30 |
Document Sequence is inactive. Document Type is invalid. |
Document Type must be blank on the Group Type page. |
6031 |
15 |
31 |
Customer Federal flag is not valid for Service Purchase Integration. |
Change Customer or deselect the Federal check box on the Customer General Information page. |
6031 |
16 |
32 |
Customer Employee ID is not defined. |
Verify the Employee ID on the Customer Information page. |
6031 |
17 |
33 |
Customer Employee ID is invalid. |
Verify the Employee ID on the Customer Information page because it is different from the Employee ID in Pension Administration. |
6031 |
18 |
34 |
Origin ID is not valid. |
Verify the default Pension Origin ID for SetID on the Receivables Options page. |
6031 |
20 |
35 |
Document Sequence Number cannot be NEXT for Manual type. |
Verify Document Type on the Group Type page. Sequence type should not be manual. |
6031 |
24 |
36 |
Document Type is invalid. |
Verify the Document Sequence setup for the Document Type defined on the Group Type page. |
6031 |
27 |
37 |
Sequence range information does not exist. |
Verify the Document Sequence setup for the Document Type defined on the Group Type page. |
6031 |
29 |
38 |
Document Sequence Number is duplicated. |
Verify the Document Sequence setup for the Document Type defined on the Group Type page. |
6031 |
30 |
39 |
Accounting Date is required. |
Verify the Accounting Date on the Pension message. |
6031 |
31 |
40 |
Customer ID is required. |
Verify the Customer ID on the Pension message. |
6031 |
32 |
41 |
Entry Type is required. |
Verify the Entry Type on the Pension message. |
6031 |
33 |
42 |
Entry Amount cannot be zero. |
Verify the amount on the Pension message. |
6031 |
34 |
43 |
Payment Method is invalid for Pension integration. |
Service Purchase invoices must use Payment Method of CC, CHK, or DD. Verify the Payment Method default on the Customer page. |
|
|
99999 |
Message error not defined for Pension integration. |
Verify the original error message in Receivables. |