Outbound Employee Extract (API059)

Updated on 08 Jul 2024
5 Minutes to read

Print
Share
Dark

Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Interface Description

The Set Up and Maintain Suppliers business process encompasses all activities 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.

API022 Inbound Employee Load will leverage the delivered Employee Sync to get employee information from HCM to load employee data profiles in Florida PALM.

With this Outbound Interface, Employee Suppliers' records will be extracted from Florida PALM and interfaced to Agency Business System and STMS.

Click below to view the interface file layout and sample data file.

API059-Outbound Employee Extract-Layout.xlsx

API059-Sample Data.txt

Business Process Model

This interface can be found in the following business processes:

30.1.2 Import Suppliers

Selection Criteria

The interface data selection criteria include the following:

Data Field	Data Field Details
Business Unit (Required)	VENDOR.BUSINESS_UNIT Prompt
Employee Date From (Required)	VENDOR.CREATED_DTTM Prompt
Employee Date To (Required)	VENDOR.CREATED_DTTM Prompt

Data Field

Data Field Details

Business Unit (Required)

VENDOR.BUSINESS_UNIT

Prompt

Employee Date From (Required)

VENDOR.CREATED_DTTM

Prompt

Employee Date To (Required)

VENDOR.CREATED_DTTM

Prompt

File Layout

Field names and descriptions from the interface layout are provided below.

Data Field Name	Record Type	Data Field Description
Record Code	Header	Record Code identifying the information on the record.
Employee Supplier ID	Header	Florida PALM Supplier ID number.
Employee Name 1	Header	Supplier name.
Employee Name 2	Header	Additional space for Supplier name, e.g., DBA.
Status	Header	Supplier status.
Default Location	Header	Indicates the default Location to be used by the supplier.
Protected Identity	Header	Used to identify Protected Identity of Employee
Restricted Relative	Header	Used to identify Restricted Relative value of Employee
Restricted Employee	Header	Used to identify if Employee is restricted.
Sworn Certified	Header	Used to identify if Employee is Sworn Certified
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	Confidential BU	Record Code identifying the information on the record.
Employee Supplier ID	Confidential BU	This field will contain a valid Florida PALM Supplier ID for the Supplier SetID provided.
Business Unit	Confidential BU	Can have multiple Business Units.
Filler1	Additional ID	This field is reserved for future use in Florida PALM.
Filler2	Additional ID	This field is reserved for future use in Florida PALM.
Filler3	Additional ID	This field is reserved for future use in Florida PALM.
Filler4	Additional ID	This field is reserved for future use in Florida PALM.
Filler5	Additional ID	This field is reserved for future use in Florida PALM.
Filler6	Additional ID	This field is reserved for future use in Florida PALM.
Filler7	Additional ID	This field is reserved for future use in Florida PALM.
Filler8	Additional ID	This field is reserved for future use in Florida PALM.
Filler9	Additional ID	This field is reserved for future use in Florida PALM.
Filler10	Additional ID	This field is reserved for future use in Florida PALM.
Record Code	Additional ID	Record Code identifying the information on the record.
Employee Supplier ID	Additional ID	This field will contain a valid Florida PALM Supplier ID for the Supplier SetID provided.
Additional ID Type	Additional ID	Used to capture the Supplier tax identification number or social security number.
Additional ID Number	Additional ID	Supplier tax identification number.
Filler1	Additional ID	This field is reserved for future use in Florida PALM.
Filler2	Additional ID	This field is reserved for future use in Florida PALM.
Filler3	Additional ID	This field is reserved for future use in Florida PALM.
Filler4	Additional ID	This field is reserved for future use in Florida PALM.
Filler5	Additional ID	This field is reserved for future use in Florida PALM.
Filler6	Additional ID	This field is reserved for future use in Florida PALM.
Filler7	Additional ID	This field is reserved for future use in Florida PALM.
Filler8	Additional ID	This field is reserved for future use in Florida PALM.
Filler9	Additional ID	This field is reserved for future use in Florida PALM.
Filler10	Additional ID	This field is reserved for future use in Florida PALM.
Record Code	Location	Record Code identifying the information on the record.
Employee Supplier ID	Location	Florida PALM Supplier ID number.
Location Effective Date	Location	Date from which the location is effective.
Location Effective Status	Location	Status of the Location
Location Name	Location	Name and primary identifier for a given Supplier Location.
Payment Method	Location	Identifies the Supplier's payment method.
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.
Employee Supplier ID	Address	Florida PALM Supplier ID number.
Address Sequence No.	Address	Indicates Employee supplier address sequence number.
Address Effective Date	Address	Date from which the address is effective.
Address Effective Status	Address	Status of the Address
Remitting Address 1	Address	Designates the Supplier's default Remitting address.
Remitting Address 2	Address	Additional Supplier address information, e.g., Attention To, Apt., Suite, etc.
Remitting Address 3	Address	Additional Supplier address information, e.g., Attention To, Apt., Suite, etc.
Remitting City	Address	Designates the City that the Supplier is located in.
Remitting County	Address	Designates the County that the Supplier is located in.
Remitting State/Province	Address	Designates the State/Province that the Supplier is located in.
Remitting Postal	Address	Designates the Postal Code that the Supplier is located in.
Remitting Country	Address	Designates the Country that the Supplier is located in.
Employee Phone Number Type	Address	Designates Employee phone number type. It will default Business (BUSN). Required if entering a Employee phone number.
Employee Phone Number Prefix	Address	Designates the area code for the Employee phone number.
Employee Phone Number	Address	Designates the Employee phone number.
Employee Phone Extension	Address	Designates the Employee 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
02/01/2024	Original Version
05/03/2024	Updated as per DDID #0599 to include the Location Default Indicator.
05/09/2024	Updated as per DDID #0624 to include the Supplier ID in every record.
07/01/2024	Admin update for valid values of Additional ID Number field.
07/08/2024	Added File Layout and Sample Data to the article

Was this article helpful?

What's Next

Outbound FRS Retiree Information (API038)

Table of contents

Interface Description
Business Process Model
Selection Criteria
File Layout
Version History