---
updatedAt: 2026-02-16T08:49:12.000Z
agentTools:
  projectIndex: https://docs.myfatoorah.com/llms.txt
---

# TransferBalance

Endpoint

## **Overview**

The "TransferBalance" endpoint is a POST request. It is used to transfer a balance from or to the available balance of a supplier. This request has been created specifically for the [Multi-Vendors](https://docs.myfatoorah.com/docs/multiple-suppliers) feature. It works with a single supplier at each request.

The endpoint on Swagger is [Supplier\_TransferBalance](https://apitest.myfatoorah.com/swagger/ui/index#!/Supplier/Supplier_TransferBalance).

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

> 📘 Request Header
>
> Add **"Authorization": "Bearer \{Token}"** to request header. Token of demo configuration can be found [here](https://docs.myfatoorah.com/docs/test-token).

<hr />

## **Request Model**

The request is a POST request with the following parameters:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Input Parameter
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **SupplierCode**
      </td>

      <td>
        integer
      </td>

      <td>
        The supplier code you need to associate the invoice with.
      </td>
    </tr>

    <tr>
      <td>
        **TransferAmount**
      </td>

      <td>
        number
      </td>

      <td>
        The amount that will be transferred to or from the supplier.
      </td>
    </tr>

    <tr>
      <td>
        **TransferType**
      </td>

      <td>
        string
      </td>

      <td>
        **pull**\
        The balance transfers from supplier to vendor.\
        **push**\
        the balance transfers from vendor to supplier.
      </td>
    </tr>

    <tr>
      <td>
        **InternalNotes**
      </td>

      <td>
        string, optional
      </td>

      <td>
        Extra comments for your reference.
      </td>
    </tr>
  </tbody>
</Table>

<hr />

## **Response Model**

After viewing the [Response Model](https://docs.myfatoorah.com/docs/response-model) that you will get as a result of your request, here, you will find full details about the **Data** Model of this API endpoint. Let's check it and its contents.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Response Field
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **InvoiceId**
      </td>

      <td>
        integer
      </td>

      <td>

      </td>
    </tr>

    <tr>
      <td>
        **Date**
      </td>

      <td>
        string
      </td>

      <td>

      </td>
    </tr>
  </tbody>
</Table>

## **Sample Message**

Transferring the balance from supplier to vendor

```json Request
{
   "SupplierCode":33,
   "TransferAmount":100,
   "TransferType":"pull",
   "InternalNotes":"withdraw from the supplier 33 to the vendor."
}
```
```json Response
{
   "IsSuccess":true,
   "Message":"The balance transferred successfully",
   "FieldsErrors":null,
   "Data":{
      "InvoiceId":684994,
      "Date":"2021-06-29T12:46:55.7815943+03:00"
   }
}
```

Transferring the balance from vendor to supplier

```json Request
{
   "SupplierCode":33,
   "TransferAmount":100,
   "TransferType":"push",
   "InternalNotes":"withdraw from the vendor to the supplier 33."
}
```
```json Response
{
   "IsSuccess":true,
   "Message":"The balance transferred successfully",
   "FieldsErrors":null,
   "Data":{
      "InvoiceId":685852,
      "Date":"2021-06-30T11:43:13.2533227+03:00"
   }
}
```