Outbound FRS Retiree Information (API038)
  • 29 May 2024
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Outbound FRS Retiree Information (API038)

  • Dark
    Light
  • PDF

Article summary

Interface Description

The Set Up and Maintain Suppliers business process encompasses all activities that are required to set up and use a supplier record, including adding a new supplier record or requesting updates to an existing record, validating a supplier TIN, marking a supplier as confidential, and intercepting a supplier payment for various business events.

In Florida PALM, all payees are called suppliers (also known as vendors. This includes retirees, payroll suppliers, and employees. Supplier records must be established before receiving payments, except when using a Single Payment Supplier. Florida PALM provides a process for receiving supplier information from agency business systems and enterprise systems like MyFloridaMarketPlace (MFMP) and People First to import or manually record suppliers into Florida PALM.

IRIS (Integrated Retirement Information System) sends an Inbound Supplier File to Florida PALM that contains retiree records and related financial institution information. Florida PALM establishes a generic supplier record to prenote the retiree EFT information.

API038 interface file contains any addition/change to the retiree supplier name, SSN, prenotification, and banking information on FRS retiree suppliers. With this Outbound Interface, FRS retiree information will be extracted from Florida PALM and interfaced to FRS.

Business Process Model

This interface can be found in the following business processes:

Selection Criteria

The interface data selection criteria include the following:

Data Field

Data Field Details

Retiree Supplier Date From (Optional)

VENDOR.CREATED_DTTM

Prompt

Retiree Supplier Date To (Optional) 

VENDOR.CREATED_DTTM

Prompt

File Layout

Field names and descriptions from the interface layout are provided below. Please refer to the Interface Catalog for the detailed interface layout and sample data file. 

Data Field Name

Record Type

Data Field Description

Record Code

Header

Record Code identifying the information on the record.

Retiree Supplier ID

Header

This field will contain a valid Florida PALM Retiree Supplier ID for the Supplier SetID provided.

Retiree Supplier Name 1

Header

This field will contain the Retiree Supplier name.

Retiree Supplier Name 2

Header

This field is an additional space for the Retiree Supplier name.

Retiree Supplier status

Header

Indicates Retiree Supplier status.

Additional ID Type

Header

Used to capture the Retiree Supplier tax identification number or social security number.

Additional ID Number

Header

Retiree Supplier tax identification number.

DOR Levy Flag

Header

Indicates DOR Levy Flag on retiree supplier.

Supplier Flag

Header

Indicates Supplier Flag on retiree supplier.

IRS Levy Flag

Header

Indicates IRS Levy Flag on retiree supplier.

Filler1

Header

This field is reserved for future use in Florida PALM.

Filler2

Header

This field is reserved for future use in Florida PALM.

Filler3

Header

This field is reserved for future use in Florida PALM.

Filler4

Header

This field is reserved for future use in Florida PALM.

Filler5

Header

This field is reserved for future use in Florida PALM.

Record Code

Location

Record Code identifying the information on the record.

Retiree Supplier Location

Location

This field will contain a valid Supplier location for the Supplier ID provided above.

Effective Date

Location

Identifies the effective date of the supplier location.

Effective Status

Location

The effective status of the supplier Location.

Location Name

Location

Name and primary identifier for a given Retiree Supplier Location.

Payment Method

Location

Specify a Retiree Supplier payment method here or leave the field blank. If blank, the default payment method will be 'CHK'.

Prenotification Required

Location

Indicate whether or not prenotification is required for ACH/EFT Retiree Suppliers.

Prenotification Date

Location

Identifies the pre-note creation date.

Prenotification Status

Location

Indicates the pre-note status.

Bank Name

Location

Retiree Supplier bank name.

DFI ID

Location

Retiree Supplier bank DFI ID (Routing number).

Bank ID Number

Location

Retiree Supplier Bank ID (Routing number).

Bank Account Number

Location

Retiree Supplier bank account number.

Bank Account Type

Location

Retiree Supplier bank account type.

Filler1

Location

This field is reserved for future use in Florida PALM.

Filler2

Location

This field is reserved for future use in Florida PALM.

Filler3

Location

This field is reserved for future use in Florida PALM.

Filler4

Location

This field is reserved for future use in Florida PALM.

Filler5

Location

This field is reserved for future use in Florida PALM.

Filler6

Location

This field is reserved for future use in Florida PALM.

Filler7

Location

This field is reserved for future use in Florida PALM.

Filler8

Location

This field is reserved for future use in Florida PALM.

Filler9

Location

This field is reserved for future use in Florida PALM.

Filler10

Location

This field is reserved for future use in Florida PALM.

Record Code

Address

Record Code identifying the information on the record.

Address Sequence Number

Address

Indicates retiree supplier address sequence number.

Address Effective Date

Address

Date from which the address is effective.

Address Effective Status

Address

Status of the Address

Retiree Remitting Address 1

Address

Designates the Retiree Supplier's default remitting address.

Retiree Remitting Address 2

Address

Additional Supplier address information, e.g., Attention To, Apt., Suite, etc.

Retiree Remitting Address 3

Address

Additional Supplier address information, e.g., Attention To, Apt., Suite, etc.

Retiree Remitting Address 4

Address

Additional Supplier address information, e.g., Attention To, Apt., Suite, etc.

Retiree Remitting City

Address

Designates the city where the retiree supplier is located.

Remitting County

Address

Designates the county where the retiree supplier is located.

Remitting Remitting State/Province

Address

Designates the State/Province that the Retiree Supplier is located in.

Remitting Remitting Postal

Address

Designates the Postal Code that the Retiree Supplier is located in.

Remitting Remitting Country

Address

Designates the country in which the retiree supplier is located.

Retiree Supplier Phone Number Type

Address

Designates Retiree Supplier phone type. It will default Home (HOME). Required if entering a retiree supplier phone number.

Retiree Supplier Phone Number Prefix

Address

Designates the area code for the Retiree Supplier phone number.

Retiree Supplier Phone Number

Address

Designates the Retiree Supplier phone number.

Retiree Supplier Phone Extension

Address

Designates the Retiree Supplier phone extension.

Filler1

Address

This field is reserved for future use in Florida PALM.

Filler2

Address

This field is reserved for future use in Florida PALM.

Filler3

Address

This field is reserved for future use in Florida PALM.

Filler4

Address

This field is reserved for future use in Florida PALM.

Filler5

Address

This field is reserved for future use in Florida PALM.

Filler6

Address

This field is reserved for future use in Florida PALM.

Filler7

Address

This field is reserved for future use in Florida PALM.

Filler8

Address

This field is reserved for future use in Florida PALM.

Filler9

Address

This field is reserved for future use in Florida PALM.

Filler10

Address

This field is reserved for future use in Florida PALM.

Version History

Date

Revision Description

03/12/2024

Original Version

Design Document(s)


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.