Outbound Employee Extract (API059)
  • 29 May 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Outbound Employee Extract (API059)

  • Dark
    Light
  • PDF

Article summary

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.

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

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. 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.

Employee Supplier SetID

Header

SetID the supplier record is stored under in Florida PALM.

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.

Additional ID Type

Header

Used to capture the Employee Source System ID.

Additional ID Number

Header

Employee Source System ID.

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

Location

Record Code identifying the information on the record.

Default Location (Main Location)

Location

Identifies the default supplier Location.

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.

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



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.