GetSupplierDashboard

Endpoint

Overview

The "GetSupplierDashboard" endpoint is a GET request. It is used to get the supplier dashboard. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is Supplier_GetDashboard.

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 GET request with the following parameters:

Input Parameter

Type

Description

SupplierCode

integer


Response Model

The response is a SupplierDashBoard object as follows:

Response Field

Type

Description

TotalNumberOfTransactions

integer

It is the count of transactions made for this supplier.

TotalValueOfTransactions

number

It is the sum of the "InvoiceValue" parameter of transactions made for this supplier. It indicates the total sum of invoices of transactions before deducting Myaftoorah fees and the vendor fees.

TotalSupplierInvoiceShare

number

It is the sum of the "InvoiceShare" parameter of transactions made for this supplier. It indicates the sum of all supplier share values of transactions made for this supplier.

TotalDepositedAmount

number

It indicates the actual amounts deposited into the supplier's bank account.

TotalAwaitingBalance

number

It is the current awaiting balance for a specific supplier. It is the sum of supplier share values after deducting the MyFatoorah fees and the vendor fees. This amount is used in refunding or transferring the balance between the vendor and supplier. This amount will be available until the deposit terms interval is up.

TotalAwaitingToTransfer

number

After the deposit terms interval ends, the "TotalAwaitingBalance" becomes the "TotalAwaitingToTransfer" amount to be deposited in the supplier bank account.

IsApproved

boolean

It is the supplier approval status. It will be true if MyFatoorah approved the provided supplier.

IsActive

boolean

It is the supplier activity status.


Sample Message

/v2/GetSupplierDashboard?SupplierCode=69
{
    "TotalAwitingBalance": 0.0,
    "TotalNumberOfTranasations": 0,
    "TotalValueOfTranasations": 0.000,
    "TotalDepositedAmount": 0.00,
    "IsApproved": false,
    "IsActive": true
}


Did this page help you?