Edara API
    Edara API
    • Edara API Walk Through
    • Edara Webhooks
    • Accounting
      • Returns a list of Taxs
        GET
      • Returns a list of Accounts
        GET
      • Returns a list of NP Report
        GET
      • Returns a list of NR Report
        GET
      • Return a Tax by ID
        GET
      • Returns a list of Cost Centers
        GET
      • Returns an Account by Id
        GET
      • Return a Currency by ID
        GET
      • Delete an existing Currency
        DELETE
      • Return a Tax by Name
        GET
      • Return a Taxes by Rate
        GET
      • Return a Taxes by Scope
        GET
      • Returns an Cost Center by Id
        GET
      • Return a E-Invoice tax codes by country
        GET
      • Returns a list of Accounts by Account Type
        GET
      • Return a Currency by Code
        GET
      • Returns a list of Account Nodes
        GET
      • Returns a list of Currencies
        GET
      • Update an existing Currency
        PUT
      • Create a new Currency
        POST
      • Return account by description
        GET
      • Return a Journal Entry by Code
        GET
      • Returns an Account
        GET
      • Returns an Account
        GET
      • Returns an Account by ClassificationCode
        GET
      • Returns an Account
        GET
      • Returns Account Balance
        GET
      • UpdateTax
        PUT
      • Create a new Tax
        POST
      • Update an existing Currency
        PUT
      • Update a Journal Entry By Code
        PUT
      • Return a Journal Entry by Code
        POST
      • Create a Cash Out
        POST
      • Create a Journal Entry
        POST
      • Pay Sales Order By Journal Entry
        POST
      • Create a Taxable Sales Invoice
        POST
      • Delete an existing Tax
        DELETE
      • Delete an existing Currency
        DELETE
      • Delete a Journal Entry by Code
        DELETE
    • 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
      • Returns a list of Sales Order Print Templates
      • 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
      • Returns a list of Customers
      • Update an existing Customer
      • Create a new Customer
      • 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 ServiceItem by Code
      • Return a ServiceItem by Name
      • Return a SalesPerson by ExternalId
      • Returns a list of SalesPersons
      • Update an existing SalesPerson
      • Create a new SalesPerson
      • Return a ServiceItem by ExternalId
      • Returns a list of ServiceItems
      • Update an existing ServiceItem
      • Create a new ServiceItem
      • Return Customers by ExternalIds
      • Returns a list of SalesOrder
      • Update an existing SalesOrder
      • Create a new SalesOrder
      • Returns a list of SalesStores
      • Create a new SalesStore
      • Returns a list of Bundles
      • Create a new Bundle
      • 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
      • 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 StockItem Classifications
      • Create a new stockitem classification
      • Return StockItems by IDs
      • 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
      • 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
      • Returns a list of DynamicProperty Tree by User ID
      • Get stock item cost (by id) 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 Part Number
      • Return a StockItem by Code
      • Return StockItems by External IDs
      • Return StockItems by Part Numbers
      • 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
      • Get stockitems balance by warehous
      • Update existing StockItems
      • Update existing StockItems
      • Update Stock Item External Id
      • Update existing StockItems
      • Update Supplies Request
      • Update an existing StockItem
      • Update an existing Warehouse
      • Deactivate an existing StockItem
      • Update an existing issue offering
      • Update an existing receive supplies
      • Create a new Unit Of Measure
      • Create StockItems
      • Create a new issue offering
      • Create a new receive supplies
      • Delete an existing StockItem
      • Delete an existing warehouse
      • Delete an issue offering by code
      • Delete an issue offering by code

    Edara API Walk Through

    What is Edara API#

    Edara API allows users to integrate Edara ERP with external systems. Through this API, businesses can seamlessly automate data transfer and synchronization between Edara ERP and various platforms such as e-commerce websites, CRMs, and third-party tools. This provides a flexible solution for connecting and managing business operations efficiently.
    Using the Edara API, users can:
    Access data related to purchasing, invoicing, stock, and more.
    Create and manage orders, products, customers, and suppliers.
    Retrieve real-time information to streamline business processes.
    The API offers a comprehensive set of endpoints, making it easy for developers to implement custom integrations for their specific needs.

    How to Create an API User#

    To get started with the Edara API, follow these steps to create an API user:
    1.
    Access your Edara account.
    2.
    Navigate to Integrations > Rest API.
    3.
    Click Add New User.
    4.
    Provide the necessary permissions to ensure the API user has access to the appropriate data and functionalities.
    Screenshot 2024-09-24 133905.png
    Once the API user is created, you can generate an access token that will be used to authenticate and interact with the Edara API.

    How to Use the Edara API#

    After creating an API user and obtaining the API credentials, follow these steps to interact with Edara ERP using the API:

    1. Authentication#

    Edara API uses Bearer Token authentication. To authenticate API requests, include the token in the header like this:
    You will receive the token when you create the API user. The token allows secure communication between your application and Edara ERP.

    2. Base URL and Endpoints#

    The base URL for the API is:
    https://api.edara.io/
    Each API call is made to a specific endpoint. The API version is included in the URL, and the endpoint indicates the resource you are interacting with. For example:

    3. Query Parameters#

    Many endpoints allow you to specify query parameters to filter or paginate the data. Here are some common parameters:
    offset: Specifies the starting point of the data selection (e.g., the 10th record).
    limit: Limits the number of retrieved records.
    Example request with query parameters:

    4. API Example - Fetching Taxes#

    To retrieve a list of taxes from Edara, make a GET request to the following endpoint:
    Example response:
    {
  "status_code": 200,
  "result": [
    {
      "id": 1,
      "name": "VAT",
      "rate": 14.0,
      "active": true
    },
    {
      "id": 2,
      "name": "Service Tax",
      "rate": 5.0,
      "active": true
    }
  ],
  "total_count": 2
}
    This basic guide provides the necessary steps for getting started with Edara API, including authentication and making a simple GET request. Refer to the attached API documentation for more details on other available endpoints and parameters.
    Next
    Edara Webhooks
    Built with