GetSupplierDetails

Overview

The "GetSupplierDetails" endpoint is a GET request. It is used to retrieve the full information about your specific supplier. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is GetSupplierDetails.

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

Response Field	Type	Description
SupplierCode	integer
SupplierName	string
Mobile	string
Email	string
CommissionValue	number
CommissionPercentage	number
DepositTerms	string	Daily - Weekly - Monthly - OnDemand
DepositDay	string	This represents the day on which the deposit is going to take place in the case of Weekly or Monthly DepositTerms.
SupplierStatus	string	"Active", "Pending", "Rejected", "Closed", "Dormant"
Comment	string	The reason for rejection (if the supplier is rejected)
IsPercentageOfNetValue	boolean	Represents whether the CommissionPercentage is taken from the total amount paid for the supplier or from the net value
BusinessName	string	The name displayed on the MyFataoorah invoices if the value of DisplaySupplierDetails is true
DisplaySupplierDetails	boolean	Show the supplier details on the invoices of MyFatoorah instead of the vendor details
SupplierCommissions	array of objects	Customized commissions made for the payment methods for the supplier
BusinessCategory	object	Shows the MCC details of the supplier

SupplierCommissions Array

Field	Type	Description
PaymentMethodName	string	Name of the payment method
CommissionValue	number
CommissionPercentage	number
IsPercentageOfNetValue	string

BusinessCategory

Field	Type	Description
Code	string	MCC for the supplier
Name	string	Name of the MCC

Sample Message

/v2/GetSupplierDetails?suppplierCode=1

{
    "SupplierCode": 1,
    "SupplierName": "    Leuschke LLC",
    "Mobile": "3582726778",
    "Email": "[email protected]",
    "CommissionValue": 0.00,
    "CommissionPercentage": 0.000,
    "DepositTerms": "Daily",
    "DepositDay": null,
    "SupplierStatus": "Active",
    "Comment": "",
    "IsPercentageOfNetValue": false,
    "BusinessName": null,
    "DisplaySupplierDetails": false,
    "SupplierCommissions": [
        {
            "PaymentMethodName": "Apple Pay",
            "CommissionValue": 0.500,
            "CommissionPercentage": 0.000,
            "IsPercentageOfNetValue": "False"
        }
    ],
    "BusinessCategory": {
        "Code": "5941",
        "Name": "Camping products"
    }
}