| Required permission: | CustomerSalesOrder-Transaction.GET |
| GET | /CustomerSalesOrders/GST/SGP/simple | ||
|---|---|---|---|
| GET | /CustomerSalesOrders/GST/SGP/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /CustomerSalesOrders/GST/SGP/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> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | AcCusSalesOrderMSimple_GST_SGP | No | |
| DocumentDetails | form | List<AcCusSalesOrderDSimple_GST_SGP> | 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) |
| 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 Exclusive). [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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CustomerSalesOrders/GST/SGP/simple HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
SalesOrders:
[
{
DocumentHeader:
{
AcCusSalesOrderMID: String,
AcCustomerID: String,
AcSalesmanID: String,
AcLocationID: String,
DocumentDate: 0001-01-01,
DeliveryDate: 0001-01-01,
DocumentNetAmount: 0,
DocumentCentBalance: 0,
DocumentFinalAmount: 0,
RefDocumentNo: String,
DocumentRemark: String,
ExtraRemark1: String,
ExtraRemark2: String,
ExtraRemark3: String,
ExtraRemark4: String,
DocumentYourReference: String,
ShipToRemark: String,
ShipToShipVia: String,
ShipToAddress1: String,
ShipToAddress2: String,
ShipToAddress3: String,
ShipToAddress4: String,
ShipToPhone1: String,
ShipToPhone2: String,
ShipToFax: String,
ShipToContact1: String,
ShipToContact2: String,
ShipToAttention: String,
AcAccountDepartmentID: String,
AcAccountJobID: String,
IsEnableGST: String,
DocumentItemGSTAmount: 0,
DocumentItemGrossTotal: 0,
DocumentItemDiscountTotal: 0,
DocumentItemTotalPrice: 0,
DocumentItemGrossTotalWithGST: 0,
DocumentItemDiscountAmountWithGST: 0,
DocumentItemTotalPriceWithGST: 0,
DocumentItemGrossTotalWithoutGST: 0,
DocumentItemDiscountAmountWithoutGST: 0,
DocumentItemTotalPriceWithoutGST: 0
},
DocumentDetails:
[
{
AcCusSalesOrderMID: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
ItemUnitPrice: 0,
ItemQuantity: 0,
ItemGrossTotal: 0,
ItemDiscountAmount: 0,
AcTaxID: String,
ItemGSTPercent: 0,
ItemGSTAmount: 0,
ItemTotalPrice: 0,
ItemRemark1: String,
AccountNoItem: String,
AcAccountDepartmentID: String,
AcAccountJobID: String,
ItemIsGSTInclusive: String,
ItemUnitPriceInput: 0,
ItemUnitPriceWithGST: 0,
ItemGrossTotalWithGST: 0,
ItemDiscountAmountWithGST: 0,
ItemTotalPriceWithGST: 0,
ItemUnitPriceWithoutGST: 0,
ItemGrossTotalWithoutGST: 0,
ItemDiscountAmountWithoutGST: 0,
ItemTotalPriceWithoutGST: 0,
StockBarcode: String
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}