KYRIBA.GETPAYMENTFILE
Overview
Returns status of a routed payment file.
Syntax
KYRIBA.GETPAYMENTFILE([fields]; [filter]; [limit])
Note❗ The list separator (e.g., comma or semicolon) may differ depending on your Region settings.
| Parameter | Required/Optional | Description | Details |
|---|---|---|---|
| Fields | 🟨 Optional | Specify fields to return. If omitted or equal to empty space, default fields are returned. |
Default fields: Filename; Status. Enter “EXCEL” or “EXCELH” to return all the existing fields horizontally. Enter “EXCELV” to return all the existing fields vertically. Enter “JSON” to return the API response body. |
| Filter | 🟨 Optional | Enter an RSQL query to only return results that match the filter. | |
| Limit | 🟨 Optional | Specify the number of rows to return. If omitted, the default number of rows is returned. |
It is set up in: Settings ⇨ Functions ⇨ Default limit. Enter 0 to disable the limit and return all the results. |
Examples
1. Payment files that contain “DEMO” in their filename. The requested fields are the default ones and Last Acknowledgment.
Formula:
=KYRIBA.GETPAYMENTFILE(";lastACK.kyribaACK";"fileName==*DEMO*")
Result:
