Skip to main content

Use your Sage Bank Feeds integration

Learn how to write your SMB users' bank transactions to Codat via our Sage Bank Feeds integration

When you've set up the Sage Bank Feeds integration and your SMB customer has connected a source bank account to a Sage product, you can start to write bank transactions to a target bank account.

View bank account details​

To view details of the source bank accounts for a specified data connection, use the GET /bankFeedAccounts endpoint.

GET /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts

The response contains a list of bank accounts with a status of either pending or connected. For connected bank accounts, the feedStartDate property is set to the current time in UTC.

Example response​

[
  {
    "id": "acc-002",
    "accountName": "account-081",
    "accountType": "Credit",
    "accountNumber": "12345670",
    "sortCode": "123456",
    "currency": "GBP",
    "balance": 99.99,
    "modifiedDate": "2023-01-09T13:46:59.4019628Z",
    "status": "pending"
  },
  {
    "id": "acc-003",
    "accountName": "account-095",
    "accountType": "Credit",
    "accountNumber": "12345671",
    "sortCode": "123456",
    "currency": "GBP",
    "balance": 100.09,
    "modifiedDate": "2023-01-09T13:46:59.4019628Z",
    "status": "connected",
    "feedStartDate": "2023-01-09T14:56:43.773Z" // only for connected accounts
  }
]

Write bank transactions from a source bank account​

You can write Bank transactions from connected source bank accounts to target accounts in supported Sage products. The integration routes these transactions through the Sage Banking Service Provider API.

In the user's Sage package, new bank transactions for the target account will appear on the Incoming Bank Transactions UI.

Bank feeds must be written to Codat

Transactions are not automatically downloaded to Sage when the user successfully connects a bank account.

Make the following requests to the Codat API. All write requests are asynchronous.

  1. Write bank transactions to a target bank account using the Create bank transactions endpoint. Note that:

    • You can only write bank transactions to one target account at a time.
    • Bank transactions must be written in chronological order.
    • Bank transactions can't be older than the most recent transaction available on the destination bank account.
    • Bank transactions must have a date set to the current day or earlier.
    • Up to 1000 bank transactions can be written at a time.
    POST https://api.codat.io/companies/COMPANY_ID/connections/CONNECTION_ID/push/bankAccounts/ACCOUNT_ID/bankTransactions

    Where ACCOUNT_ID is the id of a connected source bank account (returned from
    GET /connectionInfo/BankFeedAccounts).

    Example request body (all fields are mandatory):

    {
      "accountId": "482342-acc-001",
      "transactions": [
        {
          "id": "7832323211-GIF",
          "amount": 450,
          "balance": 2000,
          "date": "2022-08-30T17:05:12.191Z",
          "description": "events-hospitality",
          "transactionType": "Debit"
        },
        {
          "id": "7832323211-SDC",
          "amount": 730,
          "balance": 2730,
          "date": "2022-08-31T11:06:49.191Z",
          "description": "corporate-training",
          "transactionType": "Debit"
        }
      ]
    }

    The balance of the last bank transaction in the array is used to update the balance of the specified bank account.

  2. If the data is valid, the endpoint returns a write operation with a status of Pending (202). The status changes to Success if the write operation completes successfully.

note

The status might remain as Pending for some time while Sage processes the bank transactions.

  1. Repeat the request for the remainder of the SMB customer's connected bank accounts.
Was this page useful?
👏
👍
🤔
👎
😭

Contents

Suggest edits