MYmyfatoorah
Supplier

CreateSupplier

Adds a new supplier to your MyFatoorah account. This endpoint is used to create suppliers for multi-vendor functionality, and determine supplier's basic settings.

post/v2/CreateSupplier

Request

  • Base URL
    https://apitest.myfatoorah.com
  • URL
    https://apitest.myfatoorah.com/v2/CreateSupplier
  • Auth
    HTTP bearer

Request body

SupplierNamestring required

The name of the supplier

Mobilestring required

The mobile number of the supplier

Emailstring email required

The email address of the supplier

CommissionValuenumber

A fixed value which will be deducted from each transaction

CommissionPercentagenumber

A percentage value which will be deducted from each transaction

IsPercentageOfNetValueboolean

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'Daily' | 'Weekly' | 'Monthly' | 'OnDemand'

Daily for daily deposits, Weekly for weekly deposits, Monthly for monthly deposits, OnDemand for on hold deposits

DepositDaystring

Specifies on which day the deposit should take place. Effective only for weekly and monthly. Weekly: values between 1 and 5 (Sunday to Thursday), can enter multiple days separated by comma. Monthly: values between 1 and 30, accepts only a single value

BankIdinteger

Must be from the bank list received from GetBanks

BankAccountHolderNamestring

Should be string without any special characters or numbers

BankAccountstring

Bank account number, only numbers

Ibanstring

Should be valid IBAN

IsActiveboolean

Indicates if the supplier is active

DisplaySupplierDetailsboolean

true: 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

The name of the business that will be displayed on the invoice

BusinessType1 | 2

1 for Home Business, 2 for Company

Response

Successful response

IsSuccessboolean

Indicates if the request was successful

Messagestring

Response message

Changes

No recorded changes to this operation across all 1 revision of this API.