v1

latestOpenAPI 3.0.02026-07-24440173.4 KB
Supplier

GetSuppliers

Retrieves a list that contains full information about your suppliers.

get/v2/GetSuppliers

Response

Successful response

SupplierCodeinteger

The unique supplier code

SupplierNamestring

The supplier name

Mobilestring

The supplier mobile number

Emailstring

The supplier email address

CommissionValuenumber

Fixed commission value deducted from each transaction

CommissionPercentagenumber

Percentage commission deducted from each transaction

DepositTermsstring

Deposit frequency: Daily, Weekly, Monthly, or OnDemand

DepositDaystring

The day on which the deposit takes place for Weekly or Monthly deposit terms

SupplierStatusstring

Supplier status: Active, Pending, Rejected, Closed, or Dormant

Commentstring

The reason for rejection (if the supplier is rejected)

IsPercentageOfNetValueboolean

Whether the CommissionPercentage is taken from the total amount paid or from the net value

BusinessNamestring

The name displayed on MyFatoorah invoices if DisplaySupplierDetails is true

DisplaySupplierDetailsboolean

Show the supplier details on invoices instead of vendor details