---
title: "account/auto-balance-transfer/report"
method: GET
path: "/account/auto-balance-transfer/report"
tags: ["Account Endpoints"]
---

# account/auto-balance-transfer/report

`GET /account/auto-balance-transfer/report`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/account/auto-balance-transfer/report`
- Auth: none declared

This endpoint returns the list of transactions associated with an auto balance transfer. 

The sum of all debits/credits matches the amount of the auto-balance transfer.

A transfer created by a run of the auto-balance cron also returns the fields of that run. When SplitByCounterparty is enabled, the cron creates one transfer per counterparty (the contact whose funding makes up the balance) plus, when needed, one transfer labelled Unattributed for the remainder that has no single counterparty. The report of such a transfer only lists the transactions of its counterparty, and Reconciled/Difference tell whether they add up to RawNet. A report that does not reconcile is still returned (Reconciled is false). Transfers created before runs existed are reported from the date of the previous transfer and fail when they do not reconcile.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `TransactionID` string, required

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Transactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items.
    - `0` object
      - `TransactionID` integer, required: The unique ID of the transaction.
      - `TransactionType` string, required: Transaction Type
      - `TransactionDate` string, date-time, required: Transaction date
      - `CreditAmount` number, required: The credit amount on the transaction.
      - `DebitAmount` number, required: The debit amount on the transaction.
      - `FullName` string, required: The name on the transaction.
      - `ReferenceNo` string, required: The reference number provided on the transaction.
      - `ClientAccountID` string, nullable, required: The client account ID of the contact the transaction belongs to.
  - `RunID` integer: The ID of the auto-balance run that created the transfer.
  - `SplitByCounterparty` boolean: True when the run split the balance by counterparty.
  - `Amount` string: The amount of the transfer.
  - `RawNet` string: Net of the counterparty's transactions in the window (credits minus debits). This is what the listed transactions add up to.
  - `CarriedAmount` string: Amount of earlier failed transfers of the same counterparty that this transfer takes over.
  - `Adjustment` string: Amount minus RawNet minus CarriedAmount: what was added or removed to make the transfers add up to the available balance.
  - `Reconciled` boolean: True when the listed transactions add up to RawNet (Amount when the run is not split).
  - `Difference` string: The listed transactions minus the expected amount; 0.00 when reconciled.
  - `RelatedTransactionIDs` object: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... The other transfers of the run. Empty {} when the run has no other transfer.
    - `0` integer: Transaction ID of another transfer of the run.
  - `Counterparty` object: The counterparty the transfer was made for.
    - `ClientAccountID` string, nullable, required: The client account ID of the counterparty.
    - `Name` string, nullable, required: The name of the counterparty.

## Changes

- **2026-11-03** `71f251deb318`: 11 info
  - added the optional property `Adjustment` to the response with the `200` status
  - added the optional property `Amount` to the response with the `200` status
  - added the optional property `CarriedAmount` to the response with the `200` status
  - added the optional property `Counterparty` to the response with the `200` status
  - …7 more

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/account/auto-balance-transfer/report/get.md)

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)