SmartAcc DynaMod Web API v2024.4 Build 0000

CustomerSalesOrdersSimple

Customer Module - Transaction

Customer Sales Order API

**Requires Authentication**
Required permission:	CustomerSalesOrder-Transaction.GET

The following routes are available for this service:
GET	/CustomerSalesOrders/simple
GET	/CustomerSalesOrders/simple/page/{Page}	Get records by given a page number	Each page consists of 20 records
GET	/CustomerSalesOrders/simple/SalesOrder/{AcCusSalesOrderMID}	Get a record by given a Document Number	Header and Detail record would be return if found.
GET	/CustomerSalesOrders/simple/EditDate/{fromEditDate}/{toEditDate}	Get records by given Edit Date range	Date format yyyy-MM-dd

**CustomerSalesOrdersSimple** Parameters:
Name	Parameter	Data Type	Required
Page	path	int?	No
AcCusSalesOrderMID	path	string	No
fromEditDate	path	string	No
toEditDate	path	string	No

**CustomerSalesOrdersSimpleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SalesOrders	form	List<CustomerSalesOrderSimple>	No
ResponseStatus	form	ResponseStatus	No

**CustomerSalesOrderSimple** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentHeader	form	AcCusSalesOrderMSimple	No
DocumentDetails	form	List<AcCusSalesOrderDSimple>	No

**AcCusSalesOrderMSimple** Parameters:
Name	Parameter	Data Type	Required	Description
AcCusSalesOrderMID	form	NVARCHAR(20)	Yes	Sales Order Number
AcCustomerID	form	NVARCHAR(20)	Yes	Customer ID
AcTermID	form	NVARCHAR(20)	Yes	Term ID
AcSalesmanID	form	NVARCHAR(20)	No	Salesman ID. Default to customer's salesman if not specified
AcLocationID	form	NVARCHAR(20)	Yes	Location ID
DocumentDate	form	DATE	Yes	Document Date
DeliveryDate	form	DATE	Yes	Expected Delivery Date
DocumentNetAmount	form	NUMERIC(18,2)	Yes	Net Amount. Before Round Cent Adjustment
DocumentCentBalance	form	NUMERIC(18,2)	Yes	Round Cent Adjustment Amount
DocumentFinalAmount	form	NUMERIC(18,2)	Yes	Final Amount. After Round Cent Adjustment
RefDocumentNo	form	NVARCHAR(50)	No	Reference Number
DocumentRemark	form	NVARCHAR(100)	No	Document Remark
ExtraRemark1	form	NVARCHAR(100)	No	Extra Remark 1
ExtraRemark2	form	NVARCHAR(100)	No	Extra Remark 2
ExtraRemark3	form	NVARCHAR(100)	No	Extra Remark 3
ExtraRemark4	form	NVARCHAR(100)	No	Extra Remark 4
DocumentYourReference	form	NVARCHAR(100)	No	Your Reference
ShipToRemark	form	NVARCHAR(100)	No	Ship To: Remark
ShipToShipVia	form	NVARCHAR(20)	No	Ship To: Ship Via
ShipToAddress1	form	NVARCHAR(MAX)	No	Ship To: Address 1
ShipToAddress2	form	NVARCHAR(100)	No	Ship To: Address 2
ShipToAddress3	form	NVARCHAR(100)	No	Ship To: Address 3
ShipToAddress4	form	NVARCHAR(100)	No	Ship To: Address 4
ShipToPhone1	form	NVARCHAR(100)	No	Ship To: Phone 1
ShipToPhone2	form	NVARCHAR(100)	No	Ship To: Phone 1
ShipToFax	form	NVARCHAR(100)	No	Ship To: Fax
ShipToContact1	form	NVARCHAR(100)	No	Ship To: Contact 1
ShipToContact2	form	NVARCHAR(100)	No	Ship To: Contact 2
ShipToAttention	form	NVARCHAR(100)	No	Ship To: Attention
AcAccountDepartmentID	form	NVARCHAR(20)	No	Account Department ID
EditDate	form	DATETIME	Yes	Edit Date

**AcCusSalesOrderDSimple** Parameters:
Name	Parameter	Data Type	Required	Description
AcCusSalesOrderDID	form	NVARCHAR(40)	Yes	Record ID. Recommend use GUID
AcCusSalesOrderMID	form	NVARCHAR(20)	Yes	Sales Order Number
ItemNo	form	INT	Yes	Item Number. Unique in a document.
AcStockID	form	NVARCHAR(20)	Yes	Stock ID
AcStockUOMID	form	NVARCHAR(20)	Yes	Stock UOM ID
ItemUnitPrice	form	NUMERIC(18,4)	Yes	Item Unit Price
ItemQuantity	form	NUMERIC(18,4)	Yes	Item Quantity
ItemGrossTotal	form	NUMERIC(18,2)	Yes	Item Gross Total. [Item Unit Price] x [ Item Quantity ]
ItemDiscountAmount	form	NUMERIC(18,2)	Yes	Item Discount Amount
ItemTotalPrice	form	NUMERIC(18,2)	Yes	Item Total Price. [(Unit Price x Quantity) - Discount Amount]
ItemRemark1	form	NVARCHAR(MAX)	Yes	Item Remark 1
AccountNoItem	form	NVARCHAR(20)	No	Account No Item
AcAccountDepartmentID	form	NVARCHAR(20)	No	Account Department ID

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /CustomerSalesOrders/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerSalesOrdersSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SalesOrders xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:CustomerSalesOrderSimple>
      <d2p1:DocumentDetails>
        <d2p1:AcCusSalesOrderDSimple>
          <d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID>
          <d2p1:AcCusSalesOrderDID>String</d2p1:AcCusSalesOrderDID>
          <d2p1:AcCusSalesOrderMID>String</d2p1:AcCusSalesOrderMID>
          <d2p1:AcStockID>String</d2p1:AcStockID>
          <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
          <d2p1:AccountNoItem>String</d2p1:AccountNoItem>
          <d2p1:ItemDiscountAmount>0</d2p1:ItemDiscountAmount>
          <d2p1:ItemGrossTotal>0</d2p1:ItemGrossTotal>
          <d2p1:ItemNo>0</d2p1:ItemNo>
          <d2p1:ItemQuantity>0</d2p1:ItemQuantity>
          <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
          <d2p1:ItemTotalPrice>0</d2p1:ItemTotalPrice>
          <d2p1:ItemUnitPrice>0</d2p1:ItemUnitPrice>
        </d2p1:AcCusSalesOrderDSimple>
      </d2p1:DocumentDetails>
      <d2p1:DocumentHeader>
        <d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID>
        <d2p1:AcCusSalesOrderMID>String</d2p1:AcCusSalesOrderMID>
        <d2p1:AcCustomerID>String</d2p1:AcCustomerID>
        <d2p1:AcLocationID>String</d2p1:AcLocationID>
        <d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
        <d2p1:AcTermID>String</d2p1:AcTermID>
        <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
        <d2p1:DocumentCentBalance>0</d2p1:DocumentCentBalance>
        <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
        <d2p1:DocumentFinalAmount>0</d2p1:DocumentFinalAmount>
        <d2p1:DocumentNetAmount>0</d2p1:DocumentNetAmount>
        <d2p1:DocumentRemark>String</d2p1:DocumentRemark>
        <d2p1:DocumentYourReference>String</d2p1:DocumentYourReference>
        <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
        <d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
        <d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
        <d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
        <d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
        <d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
        <d2p1:ShipToAddress1>String</d2p1:ShipToAddress1>
        <d2p1:ShipToAddress2>String</d2p1:ShipToAddress2>
        <d2p1:ShipToAddress3>String</d2p1:ShipToAddress3>
        <d2p1:ShipToAddress4>String</d2p1:ShipToAddress4>
        <d2p1:ShipToAttention>String</d2p1:ShipToAttention>
        <d2p1:ShipToContact1>String</d2p1:ShipToContact1>
        <d2p1:ShipToContact2>String</d2p1:ShipToContact2>
        <d2p1:ShipToFax>String</d2p1:ShipToFax>
        <d2p1:ShipToPhone1>String</d2p1:ShipToPhone1>
        <d2p1:ShipToPhone2>String</d2p1:ShipToPhone2>
        <d2p1:ShipToRemark>String</d2p1:ShipToRemark>
        <d2p1:ShipToShipVia>String</d2p1:ShipToShipVia>
      </d2p1:DocumentHeader>
    </d2p1:CustomerSalesOrderSimple>
  </SalesOrders>
</CustomerSalesOrdersSimpleResponse>

SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

CustomerSalesOrdersSimple

Customer Sales Order API

HTTP + XML