---
title: "GetSupplierDashboard"
method: GET
path: "/v2/GetSupplierDashboard"
tags: ["Supplier"]
---

# GetSupplierDashboard

`GET /v2/GetSupplierDashboard`

Gets the supplier dashboard information, including transaction statistics, balance details, and approval status.

## Query parameters

- `SupplierCode` integer, required

## Response `200`

Successful response

- object
  - `TotalNumberOfTransactions` integer — The count of transactions made for this supplier
  - `TotalValueOfTransactions` number — The sum of the InvoiceValue parameter of transactions made for this supplier. It indicates the total sum of invoices of transactions before deducting MyFatoorah fees and vendor fees. This is calculated from the perspective of the vendor
  - `TotalSupplierInvoiceShare` number — 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 — The actual amounts deposited into the supplier's bank account
  - `TotalAwaitingBalance` number — 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
  - `TotalBalance` number — This represents the total amount in the supplier's MyFatoorah wallet. This amount includes amounts of invoices that are not approved yet
  - `IsApproved` boolean — The supplier approval status. It will be true if MyFatoorah approves the provided supplier
  - `IsActive` boolean — The supplier activity status

---

[API](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3.md) · [All operations](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myfatoorah/myfatoorah-api-v3/revisions/994a74287a16/schema)