EditSupplier

Endpoint

Overview

The "EditSupplier" endpoint is a POST request. It is used to edit information about a certain supplier. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is Supplier_EditSupplier.

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 POST request with the following parameters:

Input ParameterTypeDescription
SupplierCodeinteger
SupplierNamestring
Mobilestring
Emailstring
CommissionValuenumber, optionalA fixed value that will be deducted from each transaction.
CommissionPercentagenumber, optionalA percentage value that will be deducted from each transaction.
DepositTermsstring, optionalDaily for daily deposits
Weekly for weekly deposits
Monthly for monthly deposits
OnDemand for OnDemand, i.e. on hold deposits

Response Model

After viewing the Response Model that you will get as a result of your request, here, you will find full details about the Data Model of this API endpoint. Let's check it and its contents.

Response FieldTypeDescription
SupplierCode integer
SupplierEmail string
Datestring

Sample Message

{
  "SupplierCode": 115,
  "SupplierName": "supplier_name",
  "Mobile": "string",
  "Email": "[email protected]",
  "CommissionValue": 0,
  "CommissionPercentage": 0,
  "DepositTerms": "Daily",
}
{
    "IsSuccess": true,
    "Message": "The Supplier Updated Successfully!",
    "FieldsErrors": null,
    "Data": {
        "SupplierCode": 115,
        "SupplierEmail": "[email protected]",
        "Date": "2020-11-24T11:08:00.2220936+03:00"
    }
}