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 feature. It works with a single supplier at each request.

The endpoint on Swagger is 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.

---

Request Model

The request is a POST request with the following parameters:

Input Parameter	Type	Description
SupplierCode	integer	The supplier code you need to associate the invoice with.
TransferAmount	number	The amount that will be transferred to or from the supplier.
TransferType	string	pull The balance transfers from supplier to vendor. push the balance transfers from vendor to supplier.
InternalNotes	string, optional	Extra comments for your reference.

---

Response Model

After viewing the 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.

Response Field	Type	Description
InvoiceId	integer
Date	string

Sample Message

Transferring the balance from supplier to vendor

Request

{
   "SupplierCode":33,
   "TransferAmount":100,
   "TransferType":"pull",
   "InternalNotes":"withdraw from the supplier 33 to the vendor."
}

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

Request

{
   "SupplierCode":33,
   "TransferAmount":100,
   "TransferType":"push",
   "InternalNotes":"withdraw from the vendor to the supplier 33."
}

Response

{
   "IsSuccess":true,
   "Message":"The balance transferred successfully",
   "FieldsErrors":null,
   "Data":{
      "InvoiceId":685852,
      "Date":"2021-06-30T11:43:13.2533227+03:00"
   }
}