Document FreeAgent bank feeds transaction direction - #1870
Merged
Conversation
One sentence on the cross-platform write page, where the sign rule already lives.
Covers how FreeAgent takes transaction direction from the type, and the Xfer to OTHER conversion Codat applies. Nav entries point at the new pages.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| description: "Learn about our FreeAgent Bank Feeds integration" | ||
| --- | ||
|
|
||
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. |
There was a problem hiding this comment.
Use 'app' instead of 'application'.
Suggested change
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. | |
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your app (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. |
| description: "Learn about our FreeAgent Bank Feeds integration" | ||
| --- | ||
|
|
||
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. |
There was a problem hiding this comment.
📝 [vale] <Google.Parens> reported by reviewdog 🐶
Use parentheses judiciously.
| description: "Learn about our FreeAgent Bank Feeds integration" | ||
| --- | ||
|
|
||
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. |
There was a problem hiding this comment.
📝 [vale] <Google.Parens> reported by reviewdog 🐶
Use parentheses judiciously.
| description: "Learn about our FreeAgent Bank Feeds integration" | ||
| --- | ||
|
|
||
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. |
There was a problem hiding this comment.
📝 [vale] <Google.Passive> reported by reviewdog 🐶
In general, use active voice instead of passive voice ('is established').
|
|
||
| Our FreeAgent Bank Feeds integration allows you to set up a bank feed from a bank account in your application (the source bank account) to an account within FreeAgent (the target bank account). After a feed connection is established, you can write bank transactions from the source account to the target account. | ||
|
|
||
| Bank feeds functionality is part of our existing [FreeAgent accounting integration](/integrations/accounting/freeagent/accounting-freeagent). |
There was a problem hiding this comment.
Use 'capability' or 'feature' instead of 'functionality'.
Suggested change
| Bank feeds functionality is part of our existing [FreeAgent accounting integration](/integrations/accounting/freeagent/accounting-freeagent). | |
| Bank feeds capability is part of our existing [FreeAgent accounting integration](/integrations/accounting/freeagent/accounting-freeagent). |
Suggested change
| Bank feeds functionality is part of our existing [FreeAgent accounting integration](/integrations/accounting/freeagent/accounting-freeagent). | |
| Bank feeds feature is part of our existing [FreeAgent accounting integration](/integrations/accounting/freeagent/accounting-freeagent). |
|
|
||
| ## Supported data types and operations | ||
|
|
||
| Bank feeds are represented as streams of [Bank account transactions](/bank-feeds-api#/schemas/BankTransactions) written to Codat in chronological order. Target bank accounts are represented as [Bank feed accounts](/bank-feeds-api#/schemas/BankFeedAccount). |
There was a problem hiding this comment.
📝 [vale] <Google.Passive> reported by reviewdog 🐶
In general, use active voice instead of passive voice ('are represented').
|
|
||
| ## Supported data types and operations | ||
|
|
||
| Bank feeds are represented as streams of [Bank account transactions](/bank-feeds-api#/schemas/BankTransactions) written to Codat in chronological order. Target bank accounts are represented as [Bank feed accounts](/bank-feeds-api#/schemas/BankFeedAccount). |
There was a problem hiding this comment.
📝 [vale] <Google.Passive> reported by reviewdog 🐶
In general, use active voice instead of passive voice ('are represented').
Active voice, contractions, and a named group reference instead of "row above".
The sign-respecting row used FreeAgent's casing and left out `Unknown`. Codat also renames `SerChg` to `SRVCHG`, so types aren't all passed through unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Drops the per-type direction table, which we haven't verified against FreeAgent, and leaves the other types deliberately vague. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Huweey
marked this pull request as ready for review
August 5, 2026 07:51
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
|
||
| In Codat's bank transactions schema, the sign of the `amount` determines the direction of a transaction: positive is money in, negative is money out. The `transactionType` describes the kind of transaction. | ||
|
|
||
| For some transaction types, FreeAgent takes the direction from the `transactionType` and overrides the sign of the `amount`. `Xfer` is one of these types: FreeAgent always treats a transfer as money out. |
There was a problem hiding this comment.
📝 [vale] <Google.Colons> reported by reviewdog 🐶
'FreeAgent' should be in lowercase.
|
|
||
| ## Codat converts a positive transfer | ||
|
|
||
| To keep the direction consistent with the `amount` you send, Codat writes a positive `Xfer` transaction to FreeAgent as `OTHER`. FreeAgent uses the sign for `OTHER` in both directions, so the transaction is recorded as money in, matching the sign of the `amount`. |
There was a problem hiding this comment.
📝 [vale] <Google.Passive> reported by reviewdog 🐶
In general, use active voice instead of passive voice ('is recorded').
|
|
||
| ### The type appears in the description | ||
|
|
||
| FreeAgent includes the transaction type in the description that the SMB user sees against the bank transaction. A transaction sent as `Xfer` reads as `//XFER/`, followed by the amount: |
There was a problem hiding this comment.
📝 [vale] <Google.Anthropomorphism> reported by reviewdog 🐶
Don't attribute human qualities to software or hardware ('sees').
| your-transaction-description//XFER/£1.60 | ||
| ``` | ||
|
|
||
| Because a positive `Xfer` is written as `OTHER`, the SMB user sees `//OTHER/` instead: |
There was a problem hiding this comment.
📝 [vale] <Google.Passive> reported by reviewdog 🐶
In general, use active voice instead of passive voice ('is written').
| your-transaction-description//XFER/£1.60 | ||
| ``` | ||
|
|
||
| Because a positive `Xfer` is written as `OTHER`, the SMB user sees `//OTHER/` instead: |
There was a problem hiding this comment.
📝 [vale] <Google.Anthropomorphism> reported by reviewdog 🐶
Don't attribute human qualities to software or hardware ('sees').
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
|
Link check results: |
NathanJCodat
approved these changes
Aug 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
FreeAgent takes transaction direction from
transactionType, not the sign ofamount, unlike Xero and QuickBooks Online. Codat now sends a positiveXferasOTHERso the sign is honored, and FreeAgent shows the type in the description the SMB sees.Two separable commits:
Type of change