| Required permission: | CustomerSalesOrder-Transaction.GET |
| GET | /CustomerSalesOrders/GST/SGP/Currency/simple | ||
|---|---|---|---|
| GET | /CustomerSalesOrders/GST/SGP/Currency/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /CustomerSalesOrders/GST/SGP/Currency/simple/SalesOrder/{AcCusSalesOrderMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | |
| AcCusSalesOrderMID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SalesOrders | form | List<CustomerSalesOrderSimple_GST_SGP_Currency> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | AcCusSalesOrderMSimple_GST_SGP_Currency | No | |
| DocumentDetails | form | List<AcCusSalesOrderDSimple_GST_SGP_Currency> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCusSalesOrderMID | form | NVARCHAR(20) | Yes | Sales Order Number |
| AcCustomerID | form | NVARCHAR(20) | Yes | Customer 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 |
| AcAccountJobID | form | NVARCHAR(20) | No | Account Job ID |
| IsEnableGST | form | NVARCHAR(1) | Yes | Is Enable GST (Y/N). SGP GST Indicator |
| DocumentItemGSTAmount | form | NUMERIC(18,6) | No | Total GST Amount (System Calculated based on Items Given) |
| DocumentItemGrossTotal | form | NUMERIC(18,2) | No | Gross Total Without GST (System Calculated based on Items Given) |
| DocumentItemDiscountTotal | form | NUMERIC(18,2) | No | Discount Total Without GST (System Calculated based on Items Given) |
| DocumentItemTotalPrice | form | NUMERIC(18,2) | No | Total Without GST (System Calculated based on Items Given) |
| DocumentItemGrossTotalWithGST | form | NUMERIC(18,6) | No | Gross Total With GST (System Calculated based on Items Given) |
| DocumentItemDiscountAmountWithGST | form | NUMERIC(18,2) | No | Discount With GST (System Calculated based on Items Given) |
| DocumentItemTotalPriceWithGST | form | NUMERIC(18,2) | No | Total With GST (System Calculated based on Items Given) |
| DocumentItemGrossTotalWithoutGST | form | NUMERIC(18,6) | No | Gross Total Without GST (System Calculated based on Items Given) |
| DocumentItemDiscountAmountWithoutGST | form | NUMERIC(18,2) | No | Discount Without GST (System Calculated based on Items Given) |
| DocumentItemTotalPriceWithoutGST | form | NUMERIC(18,2) | No | Total Without GST (System Calculated based on Items Given) |
| AcCurrencyID | form | string | Yes | Currency ID. Default to home currency (eg: MYR/SGD) |
| CurrencyRate | form | decimal | Yes | Currency Rate. Default to 1 |
| DocumentLocalItemTotalPrice | form | decimal | Yes | Total of detail.ItemTotalPrice |
| DocumentLocalDiscountAmount | form | decimal | Yes | Document Discount Amount. Always 0 |
| DocumentLocalNetAmount | form | decimal | Yes | Total of detail.ItemTotalPrice |
| DocumentLocalCentBalance | form | decimal | Yes | Round Cent Adjustment Amount. |
| DocumentLocalFinalAmount | form | decimal | Yes | Invoice Amount. Amount After Minus Round Cent |
| DocumentItemLocalGSTAmount | form | decimal | Yes | GST Amount. Always 0 |
| DocumentLocalItemGrossTotal | form | decimal | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemGrossTotalWithGST | form | decimal | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemGrossTotalWithoutGST | form | decimal | Yes | Total of detail.ItemGrossTotal |
| DocumentLocalItemDiscountTotalWithGST | form | decimal | Yes | Total of detail.ItemDiscountAmount |
| DocumentLocalItemDiscountTotalWithoutGST | form | decimal | Yes | Total of detail.ItemDiscountAmount |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 (Tax Exclusive Price) |
| ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
| ItemGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total (Tax Exlusive). [Item Unit Price] x [Item Quantity] |
| ItemDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount (Discount given based on Tax Exclusive Gross Total) |
| AcTaxID | form | NVARCHAR(20) | No | Tax Code. SGP GST Tax Codes Only |
| ItemGSTPercent | form | NUMERIC(18,2) | Yes | Tax Rate. |
| ItemGSTAmount | form | NUMERIC(18,6) | Yes | Tax Amount |
| ItemTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Price. [(Unit Price x Quantity) - Discount Amount - Tax 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 |
| AcAccountJobID | form | NVARCHAR(20) | No | Account Job ID |
| ItemIsGSTInclusive | form | NVARCHAR(1) | Yes | Item Unit Price is GST Inclusive? (Y/N) |
| ItemUnitPriceInput | form | NUMERIC(18,4) | Yes | Item Unit Price Input (If ItemIsGSTInclusive = Y, provide Unit Price with Tax Inclusive; If ItemIsGSTInclusive = Y, provide Unit Price with Tax Exclusive ) |
| ItemUnitPriceWithGST | form | NUMERIC(18,6) | Yes | Item Unit Price (Tax Inclusive) |
| ItemGrossTotalWithGST | form | NUMERIC(18,6) | Yes | Item Gross Total (Tax Inclusive), [ItemUnitPriceWithGST] x [Quantity] |
| ItemDiscountAmountWithGST | form | NUMERIC(18,2) | Yes | Item Discount Amount (Tax Inclusive). (Discount given based on Tax Inclusive Gross Total) |
| ItemTotalPriceWithGST | form | NUMERIC(18,2) | Yes | Item Total Price. (Tax Inclusive) |
| ItemUnitPriceWithoutGST | form | NUMERIC(18,6) | Yes | Item Unit Price (Tax Exclusive) |
| ItemGrossTotalWithoutGST | form | NUMERIC(18,6) | Yes | Item Gross Total (Tax Exclusive), [ItemUnitPriceWithoutGST] x [Quantity] |
| ItemDiscountAmountWithoutGST | form | NUMERIC(18,2) | Yes | Item Discount Amount (Tax Exclusive). (Discount given based on Tax Exclusive Gross Total) |
| ItemTotalPriceWithoutGST | form | NUMERIC(18,2) | Yes | Item Total Price. (Tax Exclusive) |
| StockBarcode | form | NVARCHAR(20) | No | Stock Barcode. If Stock ID and UOM provided, Stock Barcode auto assigned accordingly. If Stock Barcode provided, Stock ID and UOM will be auto assigned accordingly. |
| ItemLocalGrossTotal | form | decimal | Yes | Item Gross Total in Local Currency. |
| ItemLocalDiscountAmount | form | decimal | Yes | Item Discount Amount in Local Currency. |
| ItemLocalGSTAmount | form | NUMERIC(18,2) | Yes | Item Tax Amount in Local Currency |
| ItemLocalTotalPrice | form | decimal | Yes | Item Total Amount in Local Currency. |
| ItemLocalGrossTotalWithGST | form | decimal | Yes | Item Gross Total with Tax Inclusive in Local Currency |
| ItemLocalGrossTotalWithoutGST | form | decimal | Yes | Item Gross Total without Tax Inclusive in Local Currency |
| ItemLocalDiscountAmountWithGST | form | decimal | Yes | Item Discount Amount with Tax Inclusive in Local Currency |
| ItemLocalDiscountAmountWithoutGST | form | decimal | Yes | Item Discount Amount without Tax Inclusive in Local Currency |
| ItemLocalTotalPriceWithGST | form | decimal | Yes | Item Total Amount with Tax Inclusive in Local Currency |
| ItemLocalTotalPriceWithoutGST | form | decimal | Yes | Item Total Amount without Tax Inclusive in Local Currency |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CustomerSalesOrders/GST/SGP/Currency/simple HTTP/1.1 Host: snr2u.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerSalesOrdersSimple_GST_SGP_Currency_Response 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_GST_SGP_Currency>
<d2p1:DocumentDetails>
<d2p1:AcCusSalesOrderDSimple_GST_SGP_Currency>
<d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID>
<d2p1:AcAccountJobID>String</d2p1:AcAccountJobID>
<d2p1:AcCusSalesOrderMID>String</d2p1:AcCusSalesOrderMID>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:AcTaxID>String</d2p1:AcTaxID>
<d2p1:AccountNoItem>String</d2p1:AccountNoItem>
<d2p1:ItemDiscountAmount>0</d2p1:ItemDiscountAmount>
<d2p1:ItemDiscountAmountWithGST>0</d2p1:ItemDiscountAmountWithGST>
<d2p1:ItemDiscountAmountWithoutGST>0</d2p1:ItemDiscountAmountWithoutGST>
<d2p1:ItemGSTAmount>0</d2p1:ItemGSTAmount>
<d2p1:ItemGSTPercent>0</d2p1:ItemGSTPercent>
<d2p1:ItemGrossTotal>0</d2p1:ItemGrossTotal>
<d2p1:ItemGrossTotalWithGST>0</d2p1:ItemGrossTotalWithGST>
<d2p1:ItemGrossTotalWithoutGST>0</d2p1:ItemGrossTotalWithoutGST>
<d2p1:ItemIsGSTInclusive>String</d2p1:ItemIsGSTInclusive>
<d2p1:ItemLocalDiscountAmount>0</d2p1:ItemLocalDiscountAmount>
<d2p1:ItemLocalDiscountAmountWithGST>0</d2p1:ItemLocalDiscountAmountWithGST>
<d2p1:ItemLocalDiscountAmountWithoutGST>0</d2p1:ItemLocalDiscountAmountWithoutGST>
<d2p1:ItemLocalGSTAmount>0</d2p1:ItemLocalGSTAmount>
<d2p1:ItemLocalGrossTotal>0</d2p1:ItemLocalGrossTotal>
<d2p1:ItemLocalGrossTotalWithGST>0</d2p1:ItemLocalGrossTotalWithGST>
<d2p1:ItemLocalGrossTotalWithoutGST>0</d2p1:ItemLocalGrossTotalWithoutGST>
<d2p1:ItemLocalTotalPrice>0</d2p1:ItemLocalTotalPrice>
<d2p1:ItemLocalTotalPriceWithGST>0</d2p1:ItemLocalTotalPriceWithGST>
<d2p1:ItemLocalTotalPriceWithoutGST>0</d2p1:ItemLocalTotalPriceWithoutGST>
<d2p1:ItemNo>0</d2p1:ItemNo>
<d2p1:ItemQuantity>0</d2p1:ItemQuantity>
<d2p1:ItemRemark1>String</d2p1:ItemRemark1>
<d2p1:ItemTotalPrice>0</d2p1:ItemTotalPrice>
<d2p1:ItemTotalPriceWithGST>0</d2p1:ItemTotalPriceWithGST>
<d2p1:ItemTotalPriceWithoutGST>0</d2p1:ItemTotalPriceWithoutGST>
<d2p1:ItemUnitPrice>0</d2p1:ItemUnitPrice>
<d2p1:ItemUnitPriceInput>0</d2p1:ItemUnitPriceInput>
<d2p1:ItemUnitPriceWithGST>0</d2p1:ItemUnitPriceWithGST>
<d2p1:ItemUnitPriceWithoutGST>0</d2p1:ItemUnitPriceWithoutGST>
<d2p1:StockBarcode>String</d2p1:StockBarcode>
</d2p1:AcCusSalesOrderDSimple_GST_SGP_Currency>
</d2p1:DocumentDetails>
<d2p1:DocumentHeader>
<d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID>
<d2p1:AcAccountJobID>String</d2p1:AcAccountJobID>
<d2p1:AcCurrencyID>String</d2p1:AcCurrencyID>
<d2p1:AcCusSalesOrderMID>String</d2p1:AcCusSalesOrderMID>
<d2p1:AcCustomerID>String</d2p1:AcCustomerID>
<d2p1:AcLocationID>String</d2p1:AcLocationID>
<d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
<d2p1:CurrencyRate>0</d2p1:CurrencyRate>
<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:DocumentItemDiscountAmountWithGST>0</d2p1:DocumentItemDiscountAmountWithGST>
<d2p1:DocumentItemDiscountAmountWithoutGST>0</d2p1:DocumentItemDiscountAmountWithoutGST>
<d2p1:DocumentItemDiscountTotal>0</d2p1:DocumentItemDiscountTotal>
<d2p1:DocumentItemGSTAmount>0</d2p1:DocumentItemGSTAmount>
<d2p1:DocumentItemGrossTotal>0</d2p1:DocumentItemGrossTotal>
<d2p1:DocumentItemGrossTotalWithGST>0</d2p1:DocumentItemGrossTotalWithGST>
<d2p1:DocumentItemGrossTotalWithoutGST>0</d2p1:DocumentItemGrossTotalWithoutGST>
<d2p1:DocumentItemLocalGSTAmount>0</d2p1:DocumentItemLocalGSTAmount>
<d2p1:DocumentItemTotalPrice>0</d2p1:DocumentItemTotalPrice>
<d2p1:DocumentItemTotalPriceWithGST>0</d2p1:DocumentItemTotalPriceWithGST>
<d2p1:DocumentItemTotalPriceWithoutGST>0</d2p1:DocumentItemTotalPriceWithoutGST>
<d2p1:DocumentLocalCentBalance>0</d2p1:DocumentLocalCentBalance>
<d2p1:DocumentLocalDiscountAmount>0</d2p1:DocumentLocalDiscountAmount>
<d2p1:DocumentLocalFinalAmount>0</d2p1:DocumentLocalFinalAmount>
<d2p1:DocumentLocalItemDiscountTotalWithGST>0</d2p1:DocumentLocalItemDiscountTotalWithGST>
<d2p1:DocumentLocalItemDiscountTotalWithoutGST>0</d2p1:DocumentLocalItemDiscountTotalWithoutGST>
<d2p1:DocumentLocalItemGrossTotal>0</d2p1:DocumentLocalItemGrossTotal>
<d2p1:DocumentLocalItemGrossTotalWithGST>0</d2p1:DocumentLocalItemGrossTotalWithGST>
<d2p1:DocumentLocalItemGrossTotalWithoutGST>0</d2p1:DocumentLocalItemGrossTotalWithoutGST>
<d2p1:DocumentLocalItemTotalPrice>0</d2p1:DocumentLocalItemTotalPrice>
<d2p1:DocumentLocalNetAmount>0</d2p1:DocumentLocalNetAmount>
<d2p1:DocumentNetAmount>0</d2p1:DocumentNetAmount>
<d2p1:DocumentRemark>String</d2p1:DocumentRemark>
<d2p1:DocumentYourReference>String</d2p1:DocumentYourReference>
<d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
<d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
<d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
<d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
<d2p1:IsEnableGST>String</d2p1:IsEnableGST>
<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_GST_SGP_Currency>
</SalesOrders>
</CustomerSalesOrdersSimple_GST_SGP_Currency_Response>