Filtering bank_transaction_explanations

Documentation
1

Hi,

Is there any documentation on filtering the bank_transaction_explanations API?

I’d like to get a more accurate date to sync invoice payments against my system after FreeAgent has an explained transaction on it’s side, and I can’t seem to be able to filter this API by an invoice id?

Thanks!

2

Hi :waving_hand:

I’m Brad, one of the Engineers from the Banking team at FreeAgent.

Currently, we only support filtering using the from_date, to_date and updated_since filters on our /v2/bank_transaction_explanations endpoint. We have some documentation for this.

There is not a way to pass an invoice_id and only return Bank Transaction Explanations that are related to that particular invoice.

However, what you could do is:

  • Sync all Bank Transaction Explanations regularly (e.g. daily) and filter using the updated_since parameter to only get Bank Transaction Explanations that have been changed in the last day.
  • If any of the updated Bank Transaction Explanations contains an Invoice ID that you’re interested in, you can then sync these changes with your system.

Let me know if that works.

– Brad

3

Hi Brad,

Thanks for this information. I think for now I’ll just use the information on the invoice endpoint itself, while it doesn’t include the time of a payment, the date is enough to keep my side in check,

Thanks,

Joe