Guides

GetSupplierDetails

Endpoint

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 ParameterTypeDescription
SupplierCodeinteger

Response Model

Response FieldTypeDescription
SupplierCode integer
SupplierName string
Mobile string
Email string
CommissionValue number
CommissionPercentage number
DepositTerms stringDaily - Weekly - Monthly - OnDemand
DepositDaystringThis represents the day on which the deposit is going to take place in the case of Weekly or Monthly DepositTerms.
SupplierStatusstring"Active", "Pending", "Rejected",
"Closed", "Dormant"
CommentstringThe reason for rejection (if the supplier is rejected)
IsPercentageOfNetValuebooleanRepresents whether the CommissionPercentage is taken from the total amount paid for the supplier or from the net value
BusinessNamestringThe name displayed on the MyFataoorah invoices if the value of DisplaySupplierDetails is true
DisplaySupplierDetailsbooleanShow the supplier details on the invoices of MyFatoorah instead of the vendor details
SupplierCommissionsarray of objectsCustomized commissions made for the payment methods for the supplier
BusinessCategoryobjectShows the MCC details of the supplier

SupplierCommissions Array

FieldTypeDescription
PaymentMethodNamestringName of the payment method
CommissionValuenumber
CommissionPercentagenumber
IsPercentageOfNetValuestring

BusinessCategory

FieldTypeDescription
CodestringMCC for the supplier
NamestringName 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"
    }
}