Required permission: | SupplierPurchaseOrder-Transaction.GET |
GET | /SupplierPurchaseOrders/GST/SGP/simple | ||
---|---|---|---|
GET | /SupplierPurchaseOrders/GST/SGP/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
GET | /SupplierPurchaseOrders/GST/SGP/simple/PurchaseOrder/{AcSupPurchaseOrderMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
GET | /SupplierPurchaseOrders/GST/SGP/simple/PurchaseOrder/{fromDate}/{toDate} | Get a record by given a Document Date | Date format yyyy-MM-dd |
GET | /SupplierPurchaseOrders/GST/SGP/simple/EditDate/{fromEditDate}/{toEditDate} | Get a record by given a Edit Date | Date format yyyy-MM-dd |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Page | path | int? | No | |
AcSupPurchaseOrderMID | path | string | No | |
fromDate | path | string | No | |
toDate | path | string | No | |
fromEditDate | path | string | No | |
toEditDate | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PurchaseOrders | form | List<SupplierPurchaseOrderSimple_GST_SGP> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentHeader | form | AcSupPurchaseOrderMSimple_GST_SGP | No | |
DocumentDetails | form | List<AcSupPurchaseOrderDSimple_GST_SGP> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupPurchaseOrderMID | form | NVARCHAR(20) | Yes | Purchase Order Number |
AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
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 |
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 |
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) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupPurchaseOrderMID | form | NVARCHAR(20) | Yes | Purchase 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 |
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 |
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. |
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 /SupplierPurchaseOrders/GST/SGP/simple HTTP/1.1 Host: snr2u.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SupplierPurchaseOrdersSimple_GST_SGP_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel"> <PurchaseOrders xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types"> <d2p1:SupplierPurchaseOrderSimple_GST_SGP> <d2p1:DocumentDetails> <d2p1:AcSupPurchaseOrderDSimple_GST_SGP> <d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID> <d2p1:AcStockID>String</d2p1:AcStockID> <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID> <d2p1:AcSupPurchaseOrderMID>String</d2p1:AcSupPurchaseOrderMID> <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: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:AcSupPurchaseOrderDSimple_GST_SGP> </d2p1:DocumentDetails> <d2p1:DocumentHeader> <d2p1:AcAccountDepartmentID>String</d2p1:AcAccountDepartmentID> <d2p1:AcLocationID>String</d2p1:AcLocationID> <d2p1:AcSupPurchaseOrderMID>String</d2p1:AcSupPurchaseOrderMID> <d2p1:AcSupplierID>String</d2p1:AcSupplierID> <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:DocumentItemTotalPrice>0</d2p1:DocumentItemTotalPrice> <d2p1:DocumentItemTotalPriceWithGST>0</d2p1:DocumentItemTotalPriceWithGST> <d2p1:DocumentItemTotalPriceWithoutGST>0</d2p1:DocumentItemTotalPriceWithoutGST> <d2p1:DocumentNetAmount>0</d2p1:DocumentNetAmount> <d2p1:DocumentRemark>String</d2p1:DocumentRemark> <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: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:ShipToShipVia>String</d2p1:ShipToShipVia> </d2p1:DocumentHeader> </d2p1:SupplierPurchaseOrderSimple_GST_SGP> </PurchaseOrders> <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> </SupplierPurchaseOrdersSimple_GST_SGP_Response>