EditSupplier

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 EditSupplier.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

If the supplier is approved, the request to update the supplier will be reviewed first by MyFatoorah team before approving or rejecting it. While a request is under review, you cannot create another request.

Upon approval or rejection of the changes, you will receive a webhook. For more information, please check Supplier Update Request Data Model

📘
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 Parameter	Type	Description
SupplierCode	integer
SupplierName	string
Mobile	string
Email	string
CommissionValue	number, optional	A fixed value that will be deducted from each transaction.
CommissionPercentage	number, optional	A percentage value that will be deducted from each transaction.
IsPercentageOfNetValue	boolean, optional	true: deduct the percentage from the (total amount - transaction fees) false**: deduct the percentage from the total amount Affects only in case of one supplier in the request.
DepositTerms	string, optional	Daily* for daily deposits Weekly* for weekly deposits Monthly* for monthly deposits OnDemand* for OnDemand, i.e. on hold deposits
DepositDay	string, optional	It is accepted in case of Weeklyand Monthly Weekly: You can pass values between1 and5. You can add multiple values. Monthly: You can pass values between1and30**. It accepts only a single value.
BankId	integer, optional	It must be from the bank list received from GetBanks
BankAccountHolderName	string, optional	It should be string without any special characters or numbers
BankAccount	string, optional	only numbers
Iban	string, optional	It should be valid IBAN.
LogoFile	HttpFile Model, optional
BusinessName	string, optional
DisplaySupplierDetails	boolean, optional

HttpFile

Input Parameter	Type	Description
FileName	string, optional
MediaType	string, optional
Buffer	string, optional

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 Field	Type	Description
SupplierCode	integer
SupplierEmail	string
Date	string

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"
    }
}