v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Supplier

EditSupplier

Edits information about a certain supplier. 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.

post/v2/EditSupplier

Request body

SupplierCodeinteger required

The unique code of the supplier to edit

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 that will be deducted from each transaction

CommissionPercentagenumber

A percentage value that 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

It is accepted in case of Weekly and Monthly. Weekly: You can pass values between 1 and 5. You can add multiple values. Monthly: You can pass values between 1 and 30. It 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

BusinessNamestring

The name of the business

DisplaySupplierDetailsboolean

Indicates if supplier details should be displayed on the invoice

Response

Successful response

IsSuccessboolean

Indicates if the request was successful

Messagestring

Response message