| Required permission: | CustomerDeliveryOrder-Transaction.GET |
| GET | /CustomerDeliveryOrders/simple | ||
|---|---|---|---|
| GET | /CustomerDeliveryOrders/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /CustomerDeliveryOrders/simple/DeliveryOrder/{AcCusDeliveryOrderMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
| GET | /CustomerDeliveryOrders/simple/EditDate/{fromEditDate}/{toEditDate} | Get records by given Edit Date range | Date format yyyy-MM-dd |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| AcCusDeliveryOrderMID | path | string | No | |
| fromEditDate | path | DateTime? | No | |
| toEditDate | path | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeliveryOrders | form | List<CustomerDeliveryOrderSimple> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentHeader | form | AcCusDeliveryOrderMSimple | No | |
| DocumentDetails | form | List<AcCusDeliveryOrderDSimple> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Delivery 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(20) | 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(100) | 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 |
| EditDate | form | DATETIME | Yes | Edit Date |
| AcCustomerName | form | NVARCHAR(100) | No | Customer Name (Read-Only) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCusDeliveryOrderDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
| AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Delivery 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 |
| MatchIsActive | form | NVARCHAR(1) | Yes | Match Is Active. (Y/N). Default to N. If Y, please provide MatchType;MatchDocumentNo;MatchItemNo |
| MatchType | form | NVARCHAR(20) | No | Match Document Type. Valid Value: Sales Order |
| MatchDocumentNo | form | NVARCHAR(20) | No | Match Document Number. |
| MatchItemNo | form | INT | Yes | Match Document Item Number. |
| AcCusDeliveryOrderDSerial | form | List | No | Customer Delivery Order Serial List. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Customer Delivery Order Number |
| ItemNo | form | INTEGER | Yes | Item Number (Referred to AcCusDeliveryOrderD.ItemNo) |
| AcStockID | form | NVARCHAR(20) | No | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID |
| StockSerialNumber | form | NVARCHAR(40) | Yes | Stock Serial Number |
| ItemQuantity | form | INT | No | Item Quantity. Always 1. |
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 /CustomerDeliveryOrders/simple HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DeliveryOrders:
[
{
DocumentHeader:
{
AcCusDeliveryOrderMID: String,
AcCustomerID: String,
AcTermID: 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,
EditDate: 0001-01-01,
AcCustomerName: String
},
DocumentDetails:
[
{
AcCusDeliveryOrderDID: String,
AcCusDeliveryOrderMID: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
ItemUnitPrice: 0,
ItemQuantity: 0,
ItemGrossTotal: 0,
ItemDiscountAmount: 0,
ItemTotalPrice: 0,
ItemRemark1: String,
MatchIsActive: String,
MatchType: String,
MatchDocumentNo: String,
MatchItemNo: 0,
AcCusDeliveryOrderDSerial:
[
{
AcCusDeliveryOrderMID: String,
ItemNo: 0,
AcStockID: String,
AcStockUOMID: String,
StockSerialNumber: String,
ItemQuantity: 0
}
]
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
TotalRecords: 0,
TotalRecordsInPage: 0
}