Edara API
  • Edara API Walk Through
  • Edara Webhooks
  • Accounting
  • Common
  • Purchase
  • Sales
    • Return a Customer by IDGET
    • Delete an existing CustomerDELETE
    • Return a Bundle by IDGET
    • Delete an existing BundleDELETE
    • Returns a list of Sales Order Print TemplatesGET
    • Return a SalesOrder by IDGET
    • Delete an existing SalesOrderDELETE
    • Return a SalesPerson by IDGET
    • Delete an existing SalesPersonDELETE
    • Return a ServiceItem by IDGET
    • Delete an existing ServiceItemDELETE
    • Return a Customer Addresses by Customer IDGET
    • Return a Customer by CodeGET
    • Return a Customer by NameGET
    • Return a Customer by EmailGET
    • Find a CustomerGET
    • Return a Customer by ExternalIdGET
    • Return a Customer by MobileGET
    • Returns a list of CustomersGET
    • Update an existing CustomerPUT
    • Create a new CustomerPOST
    • Return a SalesOrder by CodeGET
    • Return a Sales Order Print Template by IDGET
    • GetCustomerBalanceGET
    • Return a SalesPerson by CodeGET
    • Return a SalesPerson by NameGET
    • Return a ServiceItem by CodeGET
    • Return a ServiceItem by NameGET
    • Return a SalesPerson by ExternalIdGET
    • Returns a list of SalesPersonsGET
    • Update an existing SalesPersonPUT
    • Create a new SalesPersonPOST
    • Return a ServiceItem by ExternalIdGET
    • Returns a list of ServiceItemsGET
    • Update an existing ServiceItemPUT
    • Create a new ServiceItemPOST
    • Return Customers by ExternalIdsGET
    • Returns a list of SalesOrderGET
    • Update an existing SalesOrderPUT
    • Create a new SalesOrderPOST
    • Returns a list of SalesStoresGET
    • Create a new SalesStorePOST
    • Returns a list of BundlesGET
    • Create a new BundlePOST
    • Return a list of sales documents by specific criteriaGET
    • Update existing CustomersPUT
    • Update the Header an existing SalesOrderPUT
    • Update existing CustomersPUT
    • Update existing CustomersPUT
    • Deactivate an existing CustomerPUT
    • Update an existing CustomerPUT
    • Cancel SalesOrderPUT
    • Cancel SalesOrderPUT
    • Update an existing SalesOrderPUT
    • UnIssue SalesOrderPUT
    • Deactivate an existing CustomerPUT
    • Update an existing SalesPersonPUT
    • Update an existing ServiceItemPUT
    • Update SalesOrder StatusPUT
    • Create a new SalesReturnPOST
    • Create sales order and related IO/SI and return created SO codePOST
    • Create cash-in for specified SO and update it with discount value and return created cash-in codePOST
    • Create new CustomersPOST
    • Delete an existing CustomerDELETE
    • Delete an existing SalesPersonDELETE
    • Delete an existing ServiceItemDELETE
  • Warehouse
logoPowered by Apidog
  1. Sales

Return a Customer by ExternalId

GET/v{version}/customers/FindByExternalId/{externalId}

Return a Customer by ExternalId...

Request

Path Params
externalId
string 
required
version
string 
required

The requested API version

Default:
2.0

Request samples

Responses

OK(200)
Bad Request(400)
Unauthorized(401)
Forbidden(403)
Record Not Found(404)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json

OK

Data Schema
status_code
integer <int32>
optional

Gets or sets the status_code.

error_message
string 
optional

Gets or sets the error_message.

result
object (CustomerViewModel) 
optional
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

total_count
integer <int32>
optional
Example
Not configured
Last modified: 5 days ago