The best way to upload transaction data to Flinks is to include a list of ‘already transformed’ transactions within the JSON body of your request to /Attributes/Upload. Ideally, once you receive data from an external source, you will store that response/data on your servers and subsequently ensure that it is converted into an acceptable JSON format to include within the body of your request.
Flinks expects your transformed ‘transactions’ object to include at least a TransactionDate, Description, Debit and Credit fields (Balance is required, but can be included either as a running balance or by using one of the Balance options). Please see the template below for further details on what is required.
"Transactions": [
{
"TransactionDate": "2021/01/22",
"Description": "payroll - flinks technologies",
"Debit": "100.00",
"Credit": null,
"Balance": "900.00"
},
{
"TransactionDate": "2021/01/21",
"Description": "purchase newegg - rtx 3090",
"Debit": "100.00",
"Credit": null,
"Balance": "1000.00"
},
{
"TransactionDate": "2021/01/21",
"Description": "nsf fee random",
"Debit": "10.00",
"Credit": null,
"Balance": "1110.00"
}
]
}
Field Breakdown
| Name | Format | Description | Required |
|---|---|---|---|
| TransactionDate | YYYY/MM/DD | Date the transaction occurred | Yes |
| Description | String | Description of the transaction | Yes |
| Debit | Numeric, 2 decimal points maximum | The amount of the transaction if it was a purchase/outflow. Should be “null” or left empty if it is not a debit. | Yes |
| Credit | Numeric, 2 decimal points maximum | The amount of the transaction if it was a deposit/inflow. Should be “null” or left empty if it is not a credit. | Yes |
| Balance | Numeric, 2 decimal points maximum | The running balance after the transaction has been posted. Although this is not directly required, one of either ‘Balance’, ‘MostRecentBalance’ or ‘OldestBalance’ must be provided. | Yes (Or, you can use the optional ‘MostRecentBalance’ or ‘OldestBalance’ in place if you do not have a running balance per transaction) |
Note on Transaction Order
Flinks will assume that the order of the transactions is either ascending or descending. Please ensure that this format is followed. If there are irregularities (transactions out of order) inconsistent results may be returned.