GetSuppliers

Endpoint

Overview

The "GetSuppliers" endpoint is a GET request. It is used to retrieve a list that contains full information about your suppliers. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is GetSuppliers.

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 without any parameters.

---

Response Model

The response is an array of ManageSupplierResponse objects as follows:

Response Field	Type	Description
SupplierCode	integer
SupplierName	string
Mobile	string
Email	string
CommissionValue	number
CommissionPercentage	number
DepositTerms	string
SupplierStatus	string	"Active", "Pending", "Rejected", "Closed", "Dormant"
Comment	string	The reason for rejection (if the supplier is rejected)

---

Sample Message

Request

/v2/GetSuppliers

Response

[
    {
        "SupplierCode": 25,
        "SupplierName": "string",
        "Mobile": "123456789",
        "Email": "[email protected]",
        "CommissionValue": 1.00,
        "CommissionPercentage": 2.000,
        "DepositTerms": "Daily",
        "SupplierStatus": "Active",
        "Comment": "",
        "IsPercentageOfNetValue": true,
        "BusinessName": "Supplier",
        "DisplaySupplierDetails": true,
        "SupplierCommissions": [
            {
                "PaymentMethodName": "VISA/MASTER",
                "CommissionValue": 1.000,
                "CommissionPercentage": 0.000,
                "IsPercentageOfNetValue": "False"
            }
        ]
    },
    {
        "SupplierCode": 31,
        "SupplierName": "string",
        "Mobile": "12345",
        "Email": "[email protected]",
        "CommissionValue": 0.00,
        "CommissionPercentage": 0.000,
        "DepositTerms": "OnDemand",
        "SupplierStatus": "Pending",
        "Comment": "",
        "IsPercentageOfNetValue": true,
        "BusinessName": null,
        "DisplaySupplierDetails": false,
        "SupplierCommissions": []
    },
    .....................
]

---