Edara API
  1. Schemas
Edara API
  • Edara API Walk Through
  • Edara Webhooks
  • Accounting
    • Currencies
      • Currency Details by ID
      • Delete Currency by ID
      • Currency Details by Code
      • All Currencies
      • Update Currency by ID
      • Create Currency
      • Update Currency by Code
      • Delete Currency by Code
    • Returns a list of Taxs
    • Returns a list of NP Report
    • Returns a list of NR Report
    • Return a Tax by ID
    • Returns a list of Cost Centers
    • Returns an Account by Id
    • Return a Tax by Name
    • Return a Taxes by Rate
    • Return a Taxes by Scope
    • Returns an Cost Center by Id
    • Return a E-Invoice tax codes by country
    • Returns a list of Accounts by Account Type
    • Returns a list of Account Nodes
    • Return account by description
    • Return a Journal Entry by Code
    • Returns an Account
    • Returns an Account
    • Returns an Account by ClassificationCode
    • Returns an Account
    • Returns a list of Accounts
    • Returns Account Balance
    • UpdateTax
    • Create a new Tax
    • Update a Journal Entry By Code
    • Return a Journal Entry by Code
    • Create a Cash Out
    • Create a Journal Entry
    • Pay Sales Order By Journal Entry
    • Create a Taxable Sales Invoice
    • Delete an existing Tax
    • Delete a Journal Entry by Code
  • Common
    • Returns a list of Cities
    • Update an existing City
    • Create a new City
    • Returns a list of Countries
    • Update an existing Country
    • Create a new Country
    • Returns a list of Districts
    • Update an existing District
    • Create a new District
    • Return a City by ID
    • Delete an existing City
    • Return a Country by ID
    • Delete an existing Country
    • Return a District by ID
    • Delete an existing District
    • Find a City by Name
    • Returns a list of Districts by City Id
    • Returns a list of Cities by Country Id
    • Find a Country by Name
    • Find a District by Name
    • Return a Classification by ID
    • Return a Setting by Module and Key
    • Find a Classification by Name
    • Returns a list of Setting
    • Convert money from numeric value to Arabic words
    • Convert money from numeric value to English words
    • Ping
    • Notifications
  • Purchase
    • find supplier by Id
    • Delete supplier
    • Return a PurchaseOrder by ID
    • find supplier by name
    • Returns a list of Suppliers
    • update supplier
    • create supplier
    • Returns a list of PurchaseOrder
    • Return a PurchaseOrder by Code
  • Sales
    • Return a Customer by ID
    • Delete an existing Customer
    • Return a Bundle by ID
    • Delete an existing Bundle
    • Return a SalesOrder by ID
    • Delete an existing SalesOrder
    • Return a SalesPerson by ID
    • Delete an existing SalesPerson
    • Return a ServiceItem by ID
    • Delete an existing ServiceItem
    • Return a Customer Addresses by Customer ID
    • Return a Customer by Code
    • Return a Customer by Name
    • Return a Customer by Email
    • Find a Customer
    • Return a Customer by ExternalId
    • Return a Customer by Mobile
    • Return a SalesOrder by Code
    • Return a Sales Order Print Template by ID
    • GetCustomerBalance
    • Return a SalesPerson by Code
    • Return a SalesPerson by Name
    • Return a SalesReturn by Code
    • Return a ServiceItem by Code
    • Return a ServiceItem by Name
    • Return a SalesPerson by ExternalId
    • Return a ServiceItem by ExternalId
    • Return Customers by ExternalIds
    • Returns a list of SalesStores
    • Create a new SalesStore
    • Returns a list of Bundles
    • Create a new Bundle
    • Returns a list of SalesPersons
    • Update an existing SalesPerson
    • Create a new SalesPerson
    • Returns a list of ServiceItems
    • Update an existing ServiceItem
    • Create a new ServiceItem
    • Returns a list of Sales Order Print Templates
    • Returns a list of SalesOrder
    • Update an existing SalesOrder
    • Create a new SalesOrder
    • Returns a list of Customers
    • Update an existing Customer
    • Create a new Customer
    • Return a list of sales documents by specific criteria
    • Update existing Customers
    • Update the Header an existing SalesOrder
    • Update existing Customers
    • Update existing Customers
    • Deactivate an existing Customer
    • Update an existing Customer
    • Cancel SalesOrder
    • Cancel SalesOrder
    • Update an existing SalesOrder
    • UnIssue SalesOrder
    • Deactivate an existing Customer
    • Update an existing SalesPerson
    • Update an existing ServiceItem
    • Update SalesOrder Status
    • Create a new SalesReturn
    • Create sales order and related IO/SI and return created SO code
    • Returns a list of Customers by ids
    • Create cash-in for specified SO and update it with discount value and return created cash-in code
    • Create new Customers
    • Returns a list of SalesOrder Header
    • Delete an existing Customer
    • Delete an existing SalesPerson
    • Delete an existing ServiceItem
  • Warehouse
    • Return a Brand by ID
    • Returns a list of standard units of measure
    • Returns a list of StockItems Tree by User ID
    • Return a StockItem by ID
    • Deactivate an existing StockItem
    • Delete an existing StockItem
    • Return a Warehouse by ID
    • Delete an existing warehouse
    • Return a WorkOrder by ID
    • Return a StockItem by SKU
    • Returns a list of StockItems
    • Returns a list of StockItem Classifications
    • Create a new stockitem classification
    • Return StockItems by IDs
    • Return a StockItem by SKU
    • Return a StockItem balance by ID
    • Return a Warehouse balance by Warehouse ID
    • Return a Brand by Name
    • Returns a list of Warehouse Tree by User ID
    • GetStockItemGlobalBalanceBySKU
    • Returns a list of Brands
    • Create a new Brand
    • Return StockItems by Codes
    • Return a StockItem by Code
    • GetStockItemGlobalBalanceByCode
    • Return a Warehouse by Code
    • Return a Warehouse by Name
    • Return a WorkOrder by Code
    • Return stock item global balance object by id
    • Return a StockItem by Code or SKU
    • Return stock item global balance object by id
    • Return a StockItem by Part Number
    • Returns a list of DynamicProperty Tree by User ID
    • Get stock item cost (by id) on specific date
    • Get bulk stock items cost (by ids) on specific date
    • Search for StockItems
    • Returns a list of RMA Warehouses
    • Get bulk stock items cost (by SKUs) on specific date
    • Return a StockItem balance for a specific Warehouse
    • Return a StockItem by Code
    • Return StockItems by External IDs
    • Return StockItems by Part Numbers
    • Return a StockItem by Part Number
    • Returns a list of StockItems
    • Update an existing StockItem
    • Create a new StockItem
    • Returns a list of Warehouses
    • Update an existing Warehouse
    • Create a new Warehouse
    • Get bulk stock items cost (by part numbers) on specific date
    • Validate Item Serial is Returned
    • Validate Item Serial for Returns
    • Return a all StockItems balances
    • Return a all StockItems balances
    • Get stockitems balance by warehous
    • Update existing StockItems
    • Update Supplies Request
    • Update existing StockItems
    • Update Stock Item External Id
    • Update an existing issue offering
    • Update existing StockItems
    • Update an existing receive supplies
    • Update dynamic properties By Id.
    • Update an existing StockItem
    • Update an existing Warehouse
    • Deactivate an existing StockItem
    • Create a new Unit Of Measure
    • Delete an existing StockItem
    • Delete an existing warehouse
    • Retrieves a list of warehouses based on the provided filter criteria.
    • Create StockItems
    • Delete an issue offering by code
    • Create a new issue offering
    • Delete an issue offering by code
    • Create a new receive supplies
    • Returns a list of Dynamic Properties
    • Bulk creation of new dynamic properties and their values.
    • Returns a list of Dynamic Properties
  • Schemas
    • Schemas
      • ApiResponse[List[TaxViewModel]]
      • TaxViewModel
      • ApiResponse[List[AccountViewModel]]
      • AccountViewModel
      • ApiResponse[String]
      • ApiResponse[TaxViewModel]
      • ApiResponse[List[CostCenterViewModel]]
      • CostCenterViewModel
      • ApiResponse[AccountViewModel]
      • ApiResponse[CurrencyViewModel]
      • CurrencyViewModel
      • ApiResponse[Nullable[Boolean]]
      • ApiResponse[List[Boolean]]
      • ApiResponse[CostCenterViewModel]
      • ApiResponse[List[EInvoiceTaxTypeViewModel]]
      • EInvoiceTaxTypeViewModel
      • ApiResponse[List[ChartOfAccountsNodeViewModel]]
      • ChartOfAccountsNodeViewModel
      • ApiResponse[List[CurrencyViewModel]]
      • ApiResponse[AccountingDocumentViewModel]
      • AccountingDocumentViewModel
      • AccountingDocumentDetailViewModel
      • ApiResponse[Nullable[Decimal]]
      • ApiResponse[Boolean]
      • ApiResponse[List[Tax]]
      • Tax
      • EInvoceTaxeType
      • EInvoiceTaxType_ExemptionReason
      • ApiResponse[List[String]]
      • TaxableSalesInvoiceOrderViewModel
      • ApiResponse[List[CityViewModel]]
      • CityViewModel
      • ApiResponse[Nullable[Int32]]
      • ApiResponse[List[Nullable[Int32]]]
      • ApiResponse[List[CountryViewModel]]
      • CountryViewModel
      • ApiResponse[List[DistrictViewModel]]
      • DistrictViewModel
      • ApiResponse[CityViewModel]
      • ApiResponse[CountryViewModel]
      • ApiResponse[DistrictViewModel]
      • ApiResponse[ClassificationViewModel]
      • ClassificationViewModel
      • ApiResponse[SettingViewModel]
      • SettingViewModel
      • ApiResponse[List[SettingViewModel]]
      • Ping
      • DocumentNotification
      • NotificationMessage
      • ApiResponse[SupplierViewModel]
      • SupplierViewModel
      • ApiResponse[PurchaseOrderViewModel]
      • PurchaseOrderViewModel
      • PurchaseOrderItemViewModel
      • PurchaseOrderInstallmentViewModel
      • ApiResponse[List[SupplierViewModel]]
      • ApiResponse[List[PurchaseOrderViewModel]]
      • ApiResponse[CustomerViewModel]
      • CustomerViewModel
      • CustomerAddressViewModel
      • ApiResponse[BundleViewModel]
      • BundleViewModel
      • BundleItemViewModel
      • ApiResponse[List[SalesOrderPrintTemplateViewModel]]
      • SalesOrderPrintTemplateViewModel
      • SalesOrderPrintTemplateDetailViewModel
      • ApiResponse[SalesOrderViewModel]
      • SalesOrderViewModel
      • SalesOrderItemViewModel
      • SalesOrderInstallmentViewModel
      • ApiResponse[SalesPersonViewModel]
      • SalesPersonViewModel
      • ApiResponse[ServiceItemViewModel]
      • ServiceItemViewModel
      • ApiResponse[List[CustomerAddressViewModel]]
      • ApiResponse[CustomerAddressViewModel]
      • ApiResponse[List[CustomerViewModel]]
      • ApiResponse[SalesOrderPrintTemplateViewModel]
      • ApiResponse[Decimal]
      • ApiResponse[List[SalesPersonViewModel]]
      • ApiResponse[List[ServiceItemViewModel]]
      • ApiResponse[IEnumerable[CustomerViewModel]]
      • ApiResponse[List[SalesOrderViewModel]]
      • ApiResponse[List[SalesStoreViewModel]]
      • SalesStoreViewModel
      • ApiResponse[List[BundleViewModel]]
      • ApiResponse[BatchResult[CustomerViewModel]]
      • BatchResult[CustomerViewModel]
      • CashInForSalesOrderViewModel
      • ApiResponse[BrandViewModel]
      • GetAllSalesOrderHeadersViewModel
      • BrandViewModel
      • ApiResponse[List[StandardUnitOfMeasureViewModel]]
      • StandardUnitOfMeasureViewModel
      • ApiResponse[StandardUnitOfMeasureViewModel]
      • ApiResponse[List[StockItemsTreeViewModel]]
      • StockItemsTreeViewModel
      • ApiResponse[StockItemViewModel]
      • StockItemViewModel
      • DynamicPropertyInfoViewModel
      • StockItemUnitOfMeasuresViewModel
      • ApiResponse[WarehouseViewModel]
      • WarehouseViewModel
      • ApiResponse[WorkOrderViewModel]
      • StockItemChildViewModel
      • WorkOrderViewModel
      • WorkOrderItemViewModel
      • ApiResponse[List[StockItemClassificationViewModel]]
      • StockItemClassificationViewModel
      • StockitemFiltersViewModel
      • ApiResponse[IEnumerable[StockItemViewModel]]
      • ApiResponse[List[StockItemBalanceViewModel]]
      • StockItemBalanceViewModel
      • ApiResponse[StockItemBalanceViewModel]
      • ApiResponse[List[WarehouseBalanceViewModel]]
      • WarehouseBalanceViewModel
      • ApiResponse[List[WarehousesTreeViewModel]]
      • WarehousesTreeViewModel
      • ApiResponse[List[BrandViewModel]]
      • ApiResponse[StockItemGlobalBalanceViewModel]
      • StockItemGlobalBalanceViewModel
      • ApiResponse[List[StockItemViewModel]]
      • ApiResponse[List[WarehouseViewModel]]
      • ApiResponse[List[Int32]]
      • ApiResponse[List[DynamicPropertiesTreeViewModel]]
      • DynamicPropertiesTreeViewModel
      • ApiResponse[List[StockItemCostViewModel]]
      • StockItemCostViewModel
      • ApiResponse[DataTable]
      • ApiResponse[BatchResult[StockItemViewModel]]
      • BatchResult[StockItemViewModel]
      • ApiResponse[List[DynamicPropertyViewModel]]
      • UnitOfMeasureViewModel
      • SuppliesRequestViewModel
      • UnitOfMeasureDetailViewModel
      • SuppliesRequestItemViewModel
      • ApiResponse[SuppliesRequestViewModel]
      • DynamicPropertyViewModel
      • DynamicPropertyValueViewModel
      • ApiResponse[DynamicPropertyViewModel]
      • WarehouseFiltersViewModel
      • ApiResponse[DynamicPropertiesBatchInsertResult]
      • DynamicPropertiesBatchInsertResult
      • DynamicPropertyFiltersViewModel
    • RequestBodies
      • StockItemViewModelArray
      • CustomerViewModelArray
  1. Schemas

ApiResponse[List[DistrictViewModel]]

API response

{
    "status_code": 0,
    "error_message": "string",
    "result": [
        {
            "id": 0,
            "name": "string",
            "city_id": 0
        }
    ],
    "total_count": 0
}
Built with