-
Print
-
DarkLight
-
PDF
Outbound Deposit Data (ARI024)
-
Print
-
DarkLight
-
PDF
Interface Description
In Florida PALM, users can manually record items and direct journal payment data via Spreadsheet Upload, or by interfacing from an external system. The purpose of this daily outbound interface is to provide agency business systems with all completed items and direct journal payment data from Florida PALM. The process will create separate data files of new activity for each applicable agency daily.
Click below to view the interface file layout and sample data file.
Business Process Model
This interface can be found in the following business processes:
Selection Criteria
The interface data selection criteria includes the following:
Data Field | Data Field Details |
---|---|
Agency GL BU | Required |
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 | Description |
---|---|---|
Record Code | Deposit Control | Record Code identifying the Deposit Control information on the record. |
Agency Deposit Number | Deposit Control | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Deposit Business Unit | Deposit Control | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Deposit Control | Sequentially increased system generated number which uniquely identifies a deposit. |
Deposit Type | Deposit Control | Identifies a categorization for the deposit as determined during the Configuration Build Phase. |
Accounting Date | Deposit Control | Accounting Date for the deposit. This should be the bank deposit date for receipts deposited at the bank. If this is not related to a bank deposit, then this should represent a valid date in the accounting period for when the deposit is to be posted. Accounting Date used must be to an open period. |
Bank Code | Deposit Control | Identifier for the Bank. It should be a valid value configured in Florida PALM. |
Bank Account | Deposit Control | Identifier for the Bank Account that the deposit was made into. Must be a valid value for the agency based on the GL Business Unit associated with the External Bank Account within Florida PALM. |
Control Total Amount | Deposit Control | The control amount is the total payment amount of the deposit. Users can have a zero-total deposit if the payment amounts offset each other. |
Control Count | Deposit Control | Count of individual receipts included in the deposit. |
Filler1 | Deposit Control | This field is reserved for future use in Florida PALM. |
Filler2 | Deposit Control | This field is reserved for future use in Florida PALM. |
Filler3 | Deposit Control | This field is reserved for future use in Florida PALM. |
Filler4 | Deposit Control | This field is reserved for future use in Florida PALM. |
Filler5 | Deposit Control | This field is reserved for future use in Florida PALM. |
Record Code | Payment | Record Code identifying the Payment information on the record. |
Deposit Business Unit | Payment | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Payment | Sequentially increased system generated number which uniquely identifies a deposit. |
Agency Deposit Number | Payment | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Payment Sequence Number | Payment | Payment number in relation to the deposit. This must be a unique value within the current deposit (e.g. 1, 2, 3 etc). Multiple payments may be associated with a deposit. |
Payment ID | Payment | This will be used to store the payment identifier (e.g. check number, legacy system identifier) that can be used to identify the specific payment within the deposit. |
Accounting Date | Payment | Same value as the Deposit Control Accounting Date. This value is being included here in case there is a need in the future for having accounting dates that vary by payment. |
Payment Amount | Payment | Amount of the payment. This value is determined by the Agency who submitted/created the deposit. |
Payment Predictor Flag | Payment | Provide ‘Y’ if the payment is for an AR item in Florida PALM, the Item ID has been provided as a reference and the payment should be matched to an open AR. Provide ‘N’ if the payment is meant to be a direct journal payment. Default value is ‘N’. |
Direct Journal Flag | Payment | Notes that the payment is a miscellaneous/direct journal payment (i.e. not associated with an AR item). Provide ‘Y’ for yes or ‘N’ for no. Both the Payment Predictor Flag and the Miscellaneous Payment Flag cannot be selected for the same payment. |
Payment Method | Payment | The Payment Method Is typically defaulted by the deposit BU. |
Asset ID Reference | Payment | Asset ID associated with the receipt, if applicable. This value represents a value from the Asset list set up in Florida PALM. |
Supplier ID | Payment | Supplier ID associated with the receipt, if applicable. This value should represent a value from the Supplier list set up in Florida PALM. |
Filler1 | Payment | This field is reserved for future use in Florida PALM. |
Filler2 | Payment | This field is reserved for future use in Florida PALM. |
Filler3 | Payment | This field is reserved for future use in Florida PALM. |
Filler4 | Payment | This field is reserved for future use in Florida PALM. |
Filler5 | Payment | This field is reserved for future use in Florida PALM. |
Filler6 | Payment | This field is reserved for future use in Florida PALM. |
Filler7 | Payment | This field is reserved for future use in Florida PALM. |
Filler8 | Payment | This field is reserved for future use in Florida PALM. |
Filler9 | Payment | This field is reserved for future use in Florida PALM. |
Filler10 | Payment | This field is reserved for future use in Florida PALM. |
Record Code | Customer Deposit Data | Record Code identifying the Customer information on the record. |
Deposit Business Unit | Customer Deposit Data | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Customer Deposit Data | Sequentially increased system generated number which uniquely identifies a deposit. |
Agency Deposit Number | Customer Deposit Data | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Payment Sequence Number | Customer Deposit Data | Payment number in relation to the deposit. This must be a unique value within the current deposit (e.g. 1, 2, 3 etc). Multiple payments may be associated with a deposit. |
ID Sequence Number | Customer Deposit Data | Used to identify unique item references within a given payment. |
Customer ID | Customer Deposit Data | Customer ID which identifies a customer associated with the receipt. This value should represent a value from the Customer list set up in Florida PALM. |
Filler1 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler2 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler3 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler4 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler5 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler6 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler7 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler8 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler9 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Filler10 | Customer Deposit Data | This field is reserved for future use in Florida PALM. |
Record Code | Item Deposit Data | Record Code identifying the Item information on the record. |
Deposit Business Unit | Item Deposit Data | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Item Deposit Data | Sequentially increased system generated number which uniquely identifies a deposit. |
Agency Deposit Number | Item Deposit Data | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Payment Sequence Number | Item Deposit Data | Payment number in relation to the deposit. This is a unique value within the current deposit (e.g. 1, 2, 3 etc). Multiple payments may be associated with a deposit. |
ID Sequence Number | Item Deposit Data | Used to identify unique Item references within a given Payment |
Reference Qualifier Code | Item Deposit Data | For AR Item payments, the value should always be 'I'. For payments involving grants, the value should be 'LC'. |
Item | Item Deposit Data | The Item ID for the payment. This is a required field if the Reference Qualifier Code is populated. The reference number will be associated to an open receivable (Item ID) associated with the receipt. This Item ID value will represent a valid open receivable in Florida PALM. A receipt can contain one or more AR Item references, so if the receipt is for multiple Items, the Items will be sent as separate lines. |
Item Line | Item Deposit Data | Item line will be a valid line within the open receivable to which payment was applied. |
Pay Amount | Item Deposit Data | Dollar amount which was posted to open receivable line. |
Filler1 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler2 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler3 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler4 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler5 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler6 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler7 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler8 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler9 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Filler10 | Item Deposit Data | This field is reserved for future use in Florida PALM. |
Record Code | Payment Distribution | Record Code identifying the Payment Distribution information on the record. |
Deposit Business Unit | Payment Distribution | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Payment Distribution | Sequentially increased system generated number which uniquely identifies a deposit. |
Agency Deposit Number | Payment Distribution | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Payment Sequence Number | Payment Distribution | Payment number in relation to the deposit. This will be a unique value within the current deposit (e.g. 1, 2, 3 etc). Multiple payments may be associated with a deposit, and multiple distribution lines may be associated with a payment. |
Distribution Sequence Number | Payment Distribution | Numeric sequence number for the accounting distribution line for the payment. It will start with 1 and increase for each row of accounting distribution in the payment. If there is only one accounting distribution for the payment, then only the number 1 will be provided. |
Budget Date | Payment Distribution | Represents the budget date/appropriation date including the fiscal year for the budget associated with the payment. Budget Date used must be to an open period. |
GL Business Unit | Payment Distribution | Equivalent to the Florida PALM GL Business Unit for the Agency. Will be a valid value within Florida PALM. |
Organization | Payment Distribution | Organization ChartField tracks information according to a breakdown of your organization. |
Account | Payment Distribution | Identifies the General Ledger account value that will be used to record the transactions (i.e. ChartField value for revenue, expenditure, etc.)This value is determined by the Agency and is only for Direct Journal payments. |
Fund | Payment Distribution | Segregates and captures specific activities or classifies certain objectives in accordance with special regulations, restrictions, or limitations. |
Budget Entity | Payment Distribution | Budget Entity ChartField represents organizations and/or functions to which appropriations are made and typically represents a program. |
Category | Payment Distribution | Category ChartField represents both appropriation categories and revenue source codes. |
State Program | Payment Distribution | Stores Chart of Accounts information and provides the basic structure to segregate and categorize transactional and budget data. |
Grant | Payment Distribution | Grant ChartField is used for tracking grants funding. |
Contract | Payment Distribution | Contract ChartField captures expenditure and revenue transactions for two party agreements. |
OA1 | Payment Distribution | OA1 tracks optional organization reporting, cost pools, expenditures, revenues, or other specific use. |
OA2 | Payment Distribution | OA2 tracks optional organization reporting, cost pools, expenditures, revenues, or other specific use. |
PC Business Unit | Payment Distribution | Identifies the Projects Business Unit if the payment is linked to a project that has been set up in Florida PALM. Will be a valid value within Florida PALM, if populated. |
Project | Payment Distribution | If the payment is linked to a project which has been set up in Florida PALM, the corresponding value will be provided. If the Project Costing Business Unit data element is populated for a distribution line, then the file will include a Project value within that distribution line. Must be a valid value within Florida PALM if populated. Project value is required when an FCO category is recorded. |
Activity | Payment Distribution | If the payment is linked to a project which has been set up in Florida PALM, provided will be the corresponding Activity ID associated with the project. Only required if the PC Business Unit field has been populated. Must be a valid value within Florida PALM if populated. |
PC Source Type | Payment Distribution | Source types identify the purpose or origin of a transaction. |
PC Category | Payment Distribution | Project Category provides more flexibility and granularity in tracking and analyzing financial activity associated with a Project. |
PC Subcategory | Payment Distribution | Subcategories provides more flexibility and granularity in tracking and analyzing financial activity associated with a Project. |
Line Description | Payment Distribution | Additional description for the distribution line. This line description information is optional for a Direct Journal payment. |
Foreign Amount | Payment Distribution | Amount associated with the payment distribution line. |
Accounting Date | Payment Distribution | Same value as the Deposit Control Accounting Date. This value is being included here in case accounting dates vary by payment. |
Filler1 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler2 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler3 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler4 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler5 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler6 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler7 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler8 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler9 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Filler10 | Payment Distribution | This field is reserved for future use in Florida PALM. |
Record Code | Item Distribution | Record Code identifying the Payment Distribution information on the record. |
Deposit Business Unit | Item Distribution | Equivalent to the Florida PALM AR Business Unit for the Agency. |
Deposit ID | Item Distribution | Sequentially increased system generated number which uniquely identifies a deposit. |
Agency Deposit Number | Item Distribution | Agency unique deposit number is used in the bank reconciliation process. This is the Florida PALM created number or bank reference number for electronic deposits and the deposit slip number for paper deposits. |
Customer ID | Item Distribution | Customer ID which identifies a customer associated with the receipt. This value should represent a value from the Customer list set up in Florida PALM. |
Item | Item Distribution | The Item ID for the payment. This is a required field if the Reference Qualifier Code is populated. The reference number will be associated to an open receivable (Item ID) associated with the receipt. This Item ID value will represent a valid open receivable in Florida PALM. A receipt can contain one or more AR Item references, so if the receipt is for multiple Items, the Items will be sent as separate lines. |
Item Line | Item Distribution | Item line will be a valid line within the open receivable to which payment was applied. |
Item Sequence Number | Item Distribution | Used to identify unique item references within a given payment. |
Distribution Sequence Number | Item Distribution | Numeric sequence number for the accounting distribution line for the payment. Start with 1 and increase for each row of accounting distribution in the payment. If there is only one accounting distribution for the payment, then the value will be 1. |
Budget Date | Item Distribution | Represents the budget date/appropriation date including the fiscal year for the budget associated with the payment. Budget Date used must be to an open period. |
GL Business Unit | Item Distribution | Equivalent to the Florida PALM GL Business Unit for the Agency. Will be a valid value within Florida PALM. |
Organization | Item Distribution | Organization ChartField tracks information according to a breakdown of your organization. |
Account | Item Distribution | Identifies the General Ledger account value that will be used to record the transactions (i.e. ChartField value for revenue, expenditure, etc.) |
Fund | Item Distribution | Segregates and captures specific activities or classifies certain objectives in accordance with special regulations, restrictions, or limitations. |
Budget Entity | Item Distribution | Budget Entity ChartField represents organizations and/or functions to which appropriations are made and typically represents a program. |
Category | Item Distribution | Category ChartField represents both appropriation categories and revenue source codes. |
State Program | Item Distribution | Stores Chart of Accounts information and provides the basic structure to segregate and categorize transactional and budget data. |
Grant | Item Distribution | Grant ChartField is used for tracking grants funding. |
Contract | Item Distribution | Contract ChartField captures expenditure and revenue transactions for two party agreements. |
OA1 | Item Distribution | OA1 tracks optional organization reporting, cost pools, expenditures, revenues, or other specific use. |
OA2 | Item Distribution | OA2 tracks optional organization reporting, cost pools, expenditures, revenues, or other specific use. |
PC Business Unit | Item Distribution | Identifies the Projects Business Unit if the payment is linked to a project that has been set up in Florida PALM. Will be a valid value within Florida PALM, if populated. |
Project | Item Distribution | If the payment is linked to a project which has been set up in Florida PALM, the corresponding value will be provided. If the Project Costing Business Unit data element is populated for a distribution line, then the file will include a Project value within that distribution line. Must be a valid value within Florida PALM if populated. Project value is required when an FCO category is recorded. |
Activity | Item Distribution | If the payment is linked to a project which has been set up in Florida PALM, provided will be the corresponding Activity ID associated with the project. Only required if the PC Business Unit field has been populated. Will be a valid value within Florida PALM if provided. |
PC Source Type | Item Distribution | Source types identify the purpose or origin of a transaction. |
PC Category | Item Distribution | Project Category provides more flexibility and granularity in tracking and analyzing financial activity associated with a Project. |
PC Subcategory | Item Distribution | Subcategories provides more flexibility and granularity in tracking and analyzing financial activity associated with a Project. |
Line Description | Item Distribution | Additional description for the distribution line. This line description information is optional for an AR payment. |
Foreign Amount | Item Distribution | Amount associated with the item distribution line. |
Accounting Date | Item Distribution | Accounting Date of the payment that was applied to the item. |
Filler1 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler2 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler3 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler4 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler5 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler6 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler7 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler8 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler9 | Item Distribution | This field is reserved for future use in Florida PALM. |
Filler10 | Item Distribution | This field is reserved for future use in Florida PALM. |
Version History
Date | Revision Description |
---|---|
02/01/2024 | Original Version |
05/22/2024 | Updated Bank Code field type to Character; Updated Asset and Supplier ID record type to Payment; Updated Foreign Amount value in Item Distribution record from 23.3 to 23. |
10/01/2024 | Added key fields (Deposit BU, Deposit ID, Agency Deposit Number) to all records where applicable. |
10/30/2024 | Updated based on 10/29/2024 version history: 1. Removed SS (seconds) from the file name. 2. Changed the 'Account' field length to 6 on Item Distribution record. 3. Changed required (Y) fields to conditional (C) on Item Deposit Data, Customer Deposit Data, Payment Distribution Data and Item Distribution records. |