---
title: "CreateSupplier"
method: POST
path: "/v2/CreateSupplier"
tags: ["Supplier"]
---

# CreateSupplier

`POST /v2/CreateSupplier`

## Request

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

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.

## Request body

- object
  - `SupplierName` string, required: The name of the supplier
  - `Mobile` string, required: The mobile number of the supplier
  - `Email` string, email, required: The email address of the supplier
  - `CommissionValue` number: A fixed value which will be deducted from each transaction
  - `CommissionPercentage` number: A percentage value which will be deducted from each transaction
  - `IsPercentageOfNetValue` boolean: 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
  - `DepositDay` string: 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
  - `BankId` integer: Must be from the bank list received from GetBanks
  - `BankAccountHolderName` string: Should be string without any special characters or numbers
  - `BankAccount` string: Bank account number, only numbers
  - `Iban` string: Should be valid IBAN
  - `IsActive` boolean: Indicates if the supplier is active
  - `LogoFile` object: Logo file for the supplier
    - `FileName` string: The file name
    - `MediaType` string: The media type
    - `Buffer` string: The file buffer
  - `DisplaySupplierDetails` boolean: 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
  - `BusinessName` string: The name of the business that will be displayed on the invoice
  - `BusinessType` 1 | 2: 1 for Home Business, 2 for Company

## Response `200`

Successful response

- object
  - `IsSuccess` boolean: Indicates if the request was successful
  - `Message` string: Response message
  - `FieldsErrors` unknown[]: List of validation errors if any
    - unknown
  - `Data` object: Supplier creation result
    - `SupplierCode` integer: The unique code assigned to the supplier
    - `SupplierEmail` string: The email address of the supplier
    - `Date` string: The date when the supplier was created

---

[API](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2.md) - [All operations](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/revisions/4c0c2a3af558?raw)