Edara API
  1. Sales
Edara API
  • Edara API Walk Through
  • Edara Webhooks
  • Accounting
    • Returns a list of Taxs
    • Returns a list of Accounts
    • 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 Currency by ID
    • Delete an existing Currency
    • 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
    • Return a Currency by Code
    • Returns a list of Account Nodes
    • Returns a list of Currencies
    • Update an existing Currency
    • Create a new Currency
    • 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 Account Balance
    • UpdateTax
    • Create a new Tax
    • Update an existing Currency
    • 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 an existing Currency
    • 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
      GET
    • Delete an existing Customer
      DELETE
    • Return a Bundle by ID
      GET
    • Delete an existing Bundle
      DELETE
    • Returns a list of Sales Order Print Templates
      GET
    • Return a SalesOrder by ID
      GET
    • Delete an existing SalesOrder
      DELETE
    • Return a SalesPerson by ID
      GET
    • Delete an existing SalesPerson
      DELETE
    • Return a ServiceItem by ID
      GET
    • Delete an existing ServiceItem
      DELETE
    • Return a Customer Addresses by Customer ID
      GET
    • Return a Customer by Code
      GET
    • Return a Customer by Name
      GET
    • Return a Customer by Email
      GET
    • Find a Customer
      GET
    • Return a Customer by ExternalId
      GET
    • Return a Customer by Mobile
      GET
    • Returns a list of Customers
      GET
    • Update an existing Customer
      PUT
    • Create a new Customer
      POST
    • Return a SalesOrder by Code
      GET
    • Return a Sales Order Print Template by ID
      GET
    • GetCustomerBalance
      GET
    • Return a SalesPerson by Code
      GET
    • Return a SalesPerson by Name
      GET
    • Return a ServiceItem by Code
      GET
    • Return a ServiceItem by Name
      GET
    • Return a SalesPerson by ExternalId
      GET
    • Returns a list of SalesPersons
      GET
    • Update an existing SalesPerson
      PUT
    • Create a new SalesPerson
      POST
    • Return a ServiceItem by ExternalId
      GET
    • Returns a list of ServiceItems
      GET
    • Update an existing ServiceItem
      PUT
    • Create a new ServiceItem
      POST
    • Return Customers by ExternalIds
      GET
    • Returns a list of SalesOrder
      GET
    • Update an existing SalesOrder
      PUT
    • Create a new SalesOrder
      POST
    • Returns a list of SalesStores
      GET
    • Create a new SalesStore
      POST
    • Returns a list of Bundles
      GET
    • Create a new Bundle
      POST
    • Return a list of sales documents by specific criteria
      GET
    • Update existing Customers
      PUT
    • Update the Header an existing SalesOrder
      PUT
    • Update existing Customers
      PUT
    • Update existing Customers
      PUT
    • Deactivate an existing Customer
      PUT
    • Update an existing Customer
      PUT
    • Cancel SalesOrder
      PUT
    • Cancel SalesOrder
      PUT
    • Update an existing SalesOrder
      PUT
    • UnIssue SalesOrder
      PUT
    • Deactivate an existing Customer
      PUT
    • Update an existing SalesPerson
      PUT
    • Update an existing ServiceItem
      PUT
    • Update SalesOrder Status
      PUT
    • Create a new SalesReturn
      POST
    • Create sales order and related IO/SI and return created SO code
      POST
    • Create cash-in for specified SO and update it with discount value and return created cash-in code
      POST
    • Create new Customers
      POST
    • Returns a list of SalesOrder Header
      POST
    • Delete an existing Customer
      DELETE
    • Delete an existing SalesPerson
      DELETE
    • Delete an existing ServiceItem
      DELETE
  • 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
  1. Sales

Update an existing Customer

PUT
/v{version}/customers/UpdateByCode/{customerCode}
Sales
Update an existing Customer...

Request

Path Params
customerCode
string 
required
version
string 
required
The requested API version
Default:
2.0
Body Params application/x-www-form-urlencoded
id
integer <int32>
optional
Gets or Sets Id
name
string 
required
Gets or Sets Name
code
string 
required
Gets or Sets Code
relatedaccountcode
string 
optional
Gets or Sets Code
phone
string 
optional
Gets or Sets Phone
mobile
string 
optional
Gets or Sets Mobile
email
string 
optional
Gets or Sets Email
payment_type
string 
optional
Gets or Sets PaymentType
credit_limit
number <double>
optional
Gets or Sets CreditLimit
balance
number <double>
optional
Gets or Sets Balance
shipping_term
string 
optional
Gets or Sets ShippingTerm
insurance
string 
optional
Gets or Sets Insurance
has_discount
boolean 
optional
Gets or Sets HasDiscount
discount_from
number <double>
optional
Gets or Sets Discount From
discount_to
number <double>
optional
Gets or Sets Discount To
customer_type
string 
optional
Gets or Sets Customer Type ID
pricing_type
string 
optional
Gets or Sets Pricing Type
payment_max_due_days
integer <int32>
optional
Gets or Sets Payment Max Due Days
related_account_id
integer <int32>
optional
Returns the string presentation of the object
related_account_parent_id
integer <int32>
optional
Gets or Sets Related Account Parent Id
tax_registeration_id
string 
optional
Gets or Sets Tax Registeration Id
external_id
string 
optional
Gets or Sets External ID
customer_addresses
array[object (CustomerAddressViewModel) {11}] 
optional
Gets or Sets CustomerAddresses
id
integer <int32>
optional
Gets or Sets Id
customer_id
integer <int32>
optional
Gets or Sets CustomerId
name
string 
optional
Gets or Sets Name
country_id
integer <int32>
optional
Gets or Sets CountryId
city_id
integer <int32>
optional
Gets or Sets CityId
district_id
integer <int32>
optional
Gets or Sets DistrictId
street
string 
optional
Gets or Sets Street
description
string 
optional
Gets or Sets Description
is_default
boolean 
optional
Gets or Sets IsDefault
entity_state
string 
optional
Gets or Sets State
address_phone
string 
optional
Gets or Sets AddressPhone

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v/customers/UpdateByCode/' \
--data-urlencode 'name=' \
--data-urlencode 'code='

Responses

🟢200OK
application/json
OK
Body
status_code
integer <int32>
optional
Gets or sets the status_code.
error_message
string 
optional
Gets or sets the error_message.
result
array[boolean]
optional
Gets or sets the result.
total_count
integer <int32>
optional
Example
{
  "status_code": 0,
  "error_message": "string",
  "result": [
    true
  ],
  "total_count": 0
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
Modified at 2025-02-10 16:54:43
Previous
Deactivate an existing Customer
Next
Cancel SalesOrder
Built with