v1

latestOpenAPI 3.0.02026-07-24440173.4 KB
Supplier

GetSupplierDashboard

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

get/v2/GetSupplierDashboard

Query parameters

SupplierCodeinteger required

The unique code of the supplier

Response

Successful response

TotalNumberOfTransactionsinteger

The count of transactions made for this supplier

TotalValueOfTransactionsnumber

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

TotalSupplierInvoiceSharenumber

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

TotalDepositedAmountnumber

The actual amounts deposited into the supplier's bank account

TotalAwaitingBalancenumber

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

TotalAwaitingToTransfernumber

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

TotalBalancenumber

This represents the total amount in the supplier's MyFatoorah wallet. This amount includes amounts of invoices that are not approved yet

IsApprovedboolean

The supplier approval status. It will be true if MyFatoorah approves the provided supplier

IsActiveboolean

The supplier activity status