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 Parameter | Type | Description |
|---|---|---|
| SupplierName | string | |
| Mobile | string | |
| string | ||
| CommissionValue | number, optional | A fixed value which will be deducted from each transaction. |
| CommissionPercentage | number, optional | A percentage value which 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 | You 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. |
| 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. |
| IsActive | boolean, optional | |
| LogoFile | HttpFile Model, optional | |
| DisplaySupplierDetails | boolean, optional | 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, optional | The name of the business that will be displayed on the invoice. |
| BusinessType | number, optional | 1: Home Business 2: Company |
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
{
"SupplierName": "Lonny Williamson",
"Mobile": "374-415-4939",
"Email": "[email protected]",
"CommissionValue": 0.5,
"IsPercentageOfNetValue": "true",
"CommissionPercentage": 2,
"DepositTerms": "Daily",
"BankId": "1",
"BankAccountHolderName": "Margarita Beer",
"BankAccount": "12345",
"Iban": "KW76KSFM1197681842334764641317",
"IsActive": "false",
"BusinessType": 1
}
{
"IsSuccess": true,
"Message": "The Supplier Created Successfully!",
"FieldsErrors": null,
"Data": {
"SupplierCode": 175,
"SupplierEmail": "[email protected]",
"Date": "2024-03-20T12:04:49.3812998+03:00"
}
}
Updated 8 months ago