CreateSupplier

Endpoint

Overview

The "CreateSupplier" endpoint is a POST request. It is used to add a new supplier to your Myfatoorah account. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is CreateSupplier.

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
SupplierNamestring
Mobilestring
Emailstring
CommissionValuenumber, optionalA fixed value which will be deducted from each transaction.
CommissionPercentagenumber, optionalA percentage value which will be deducted from each transaction.
IsPercentageOfNetValueboolean, optionaltrue: 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.
DepositTermsstring, optionalDaily for daily deposits
Weekly for weekly deposits
Monthly for monthly deposits
OnDemand for OnDemand, i.e. on hold deposits
DepositDaystring, optionalYou specify on which day you want the deposit to take place. It is effective only weekly and monthly.
Weekly: You can enter values between 1 and 5. This represents Sunday to Thursday. You can enter multiple days if they are separated by a comma only. "1,3,5"
Monthly: You can enter values between 1 and 30. It accepts only a single value.
BankIdinteger, optionalIt must be from the bank list received from GetBanks
BankAccountHolderNamestring, optionalIt should be string without any special characters or numbers
BankAccountstring, optionalonly numbers
Ibanstring, optionalIt should be valid IBAN.
IsActive boolean, optional
LogoFileHttpFile Model, optional
DisplaySupplierDetailsboolean, optionaltrue: The details of the suppliers will be displayed on the invoice page instead of the vendor.
false: The vendor details will be displayed on the invoice.
This is effective only if there is one supplier in the invoice.
BusinessNamestring, optionalThe name of the business that will be displayed on the invoice.

HttpFile

Input ParameterTypeDescription
FileNamestring, optional
MediaTypestring, optional
Bufferstring, 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 FieldTypeDescription
SupplierCodeinteger
SupplierEmailstring
Datestring

Sample Message

{
  "SupplierName": "name",
  "Mobile": "123456",
  "Email": "[email protected]",
  "CommissionValue": 0,
  "CommissionPercentage": 0,
  "DepositTerms": "Daily",
  "BankId": 1,
  "BankAccountHolderName": "",
  "BankAccount": "",
  "Iban": "",
  "IsActive": true
}
{
    "IsSuccess": true,
    "Message": "The Supplier Created Successfully!",
    "FieldsErrors": null,
    "Data": {
        "SupplierCode": 126,
        "SupplierEmail": "[email protected]",
        "Date": "2020-11-24T10:52:23.4591999+03:00"
    }
}