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 SalesOrder by ID

GET/v{version}/salesOrders/{salesOrderId}

Return a SalesOrder by ID...

Request

Path Params
salesOrderId
integer <int32>
required
version
string 
required

The requested API version

Default:
2.0

Request samples

Responses

OK(200)
Bad Request(400)
Unauthorized(401)
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 (SalesOrderViewModel) 
optional
order_status
string 
optional

Gets or Sets OrderStatus

id
integer <int32>
optional

Gets or Sets Id

document_code
string 
optional

Gets DocumentCode

document_type
string 
optional
paper_number
string 
optional

Gets or Sets PaperNumber

run_sheet_id
string 
optional

/// Gets or Sets RunSheetId

customer_id
integer <int32>
required

Gets or Sets CustomerId

salesPerson_id
integer <int32>
optional

Gets or Sets SalesPersonId

warehouse_id
integer <int32>
optional

Gets or Sets WarehouseId

salesstore_id
integer <int32>
optional

Gets or Sets WarehouseId

shippment_cost
number <double>
optional

Gets or Sets ShippmentCost

document_date
string <date-time>
required

Gets or Sets DocumentDate

shipping_date
string <date-time>
optional

Gets or Sets ShippingDate

gross_total
number <double>
optional

Gets or Sets GrossTotal

sub_total
number <double>
optional

Gets or Sets SubTotal

net_total
number <double>
optional

Gets or Sets NetTotal

total_item_discounts
number <double>
optional

Gets or Sets TotalItemsDiscounts

discount
number <double>
optional

Gets or Sets Discount

discount_rate
number <double>
optional

Gets or Sets Discount rate

taxable
boolean 
optional

Gets or Sets Taxable

apply_tax_after_discount
boolean 
optional

Gets or Sets ApplyTaxAfterDiscount

tax
number <double>
optional

Gets or Sets Tax

cash_amount
number <double>
optional

Gets or Sets CashAmount

currency_id
integer <int32>
optional

Gets or Sets CurrencyId

exchange_rate
number <double>
optional

Gets or Sets ExchangeRate

channel
string 
optional

Gets or Sets Channel

notes
string 
optional

Gets or Sets Notes

external_id
string 
optional

Gets or Sets External ID

related_workorder_code
string 
optional

Gets or Sets RelatedWorkOrderCode

related_workorder_value
number <double>
optional

Gets or Sets RelatedWorkOrderValue

related_salesreturn_codes
array[string]
optional

Gets or Sets RelatedSalesReturnCodes

related_salesorder_codes
array[string]
optional

Gets or Sets RelatedSalesOrderCodes

payment_information
object 
optional

Gets or Sets PaymentInformation

salesOrder_details
array[object (SalesOrderItemViewModel) {22}] 
required

Gets or Sets SalesOrderDetails

salesOrder_installments
array[object (SalesOrderInstallmentViewModel) {7}] 
optional

Gets or Sets SalesOrderInstallments

insert_user_id
integer <int32>
optional

Gets or Sets InsertUserID

insert_date
string <date-time>
optional

Gets or Sets InsertDate

update_user_id
integer <int32>
optional

Gets or Sets UpdateUserID

update_date
string <date-time>
optional

Gets or Sets UpdateDate

address_id
integer <int32>
optional

Gets or Sets AddressId

payment_status
string 
optional

Gets or Sets PaymentStatus

other_credit_amount
number <double>
optional

Gets or Sets OtherCreditAmount

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