Inbound Payment Cancellation (API006)
- 19 Aug 2024
- 2 Minutes to read
-
Print
-
DarkLight
-
PDF
Inbound Payment Cancellation (API006)
- Updated on 19 Aug 2024
- 2 Minutes to read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Interface Description
APE016 AP Payment Cancellation Extension provides the ability for agency users to cancel payments that have been issued by their Business Unit in Florida PALM Accounts Payable.
The user with the authority to process Payment Cancellations identifies the need to cancel a payment based on applicable business events. The payment will then be cancelled through the APE016 online page or interfaced through this interface. This interface will process Payment cancellation files from external systems to Florida PALM to cancel the payment and close liabilities. Payment cancellations submitted to Florida PALM via interface are considered pre-approved by agencies via their Agency Business Systems.
The interface will mimic the processing that will happen on the APE016 page, and the interfaced payments will come in as pre-approved, therefore, processing post approval will immediately trigger for these transactions.
Click below to view the interface file layout and sample data file.
Business Process Model
This interface can be found in the following business process:
Selection Criteria
The interface data selection criteria includes the following:
| Data Field | Data Field Details |
|---|---|
| RUNCNTLID | Required |
File Layout
The layout of the interface is listed below.
| Data Field Name | Record Type | Data Field Description |
|---|---|---|
| Record Code | Payment | Indicates Header information. This field is the row identifier and should be added at the start of each header row. |
| Request Description | Payment | Description of the request |
| Requesting BU | Payment | Business Unit for which request is created |
| Agency Requester Name | Payment | Used to display oprid of the requester |
| Payment Reference | Payment | Displays the payment reference to be cancelled |
| Cancel Action | Payment | Used to select the type of payment cancellation |
| Hold Reason | Payment | Used to select the reason to put reissued payment on hold |
| Cancel Reason Code | Payment | Used to display reason for payment cancellation |
| Reason for Request | Payment | Additional reason for payment cancellation |
| 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. |
| Record Code | Comment | Indicates comment information. This field is the row identifier and should be added at the start of each header row. |
| Comments | Comment | A long character field where users can add comments for the request. |
| Filler1 | Comment | This field is reserved for future use in Florida PALM. |
| Filler2 | Comment | This field is reserved for future use in Florida PALM. |
| Filler3 | Comment | This field is reserved for future use in Florida PALM. |
| Filler4 | Comment | This field is reserved for future use in Florida PALM. |
| Filler5 | Comment | This field is reserved for future use in Florida PALM. |
| Filler6 | Comment | This field is reserved for future use in Florida PALM. |
| Filler7 | Comment | This field is reserved for future use in Florida PALM. |
| Filler8 | Comment | This field is reserved for future use in Florida PALM. |
| Filler9 | Comment | This field is reserved for future use in Florida PALM. |
| Filler10 | Comment | This field is reserved for future use in Florida PALM. |
Version History
| Date | Revision Description |
|---|---|
| 12/01/2023 | Original Version |
| 08/19/2024 | Updated to reflect 7/31/2024 Update to file layout to add examples for Request Description and Payment reference |
Was this article helpful?
