Required permission: | SupplierPurchaseOrder-Transaction.GET |
GET | /SupplierPurchaseOrders/simple | ||
---|---|---|---|
GET | /SupplierPurchaseOrders/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
GET | /SupplierPurchaseOrders/simple/PurchaseOrder/{AcSupPurchaseOrderMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
GET | /SupplierPurchaseOrders/simple/PurchaseOrder/{fromDate}/{toDate} | Get a record by given a Document Date | Date format yyyy-MM-dd |
GET | /SupplierPurchaseOrders/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> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentHeader | form | AcSupPurchaseOrderMSimple | No | |
DocumentDetails | form | List<AcSupPurchaseOrderDSimple> | 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 |
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 |
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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SupplierPurchaseOrders/simple HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { PurchaseOrders: [ { DocumentHeader: { AcSupPurchaseOrderMID: String, AcSupplierID: 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, ShipToShipVia: String, ShipToAddress1: String, ShipToAddress2: String, ShipToAddress3: String, ShipToAddress4: String, ShipToPhone1: String, ShipToPhone2: String, ShipToFax: String, ShipToContact1: String, ShipToContact2: String, ShipToAttention: String, AcAccountDepartmentID: String, EditDate: 0001-01-01 }, DocumentDetails: [ { AcSupPurchaseOrderMID: String, ItemNo: 0, AcStockID: String, AcStockUOMID: String, ItemUnitPrice: 0, ItemQuantity: 0, ItemGrossTotal: 0, ItemDiscountAmount: 0, ItemTotalPrice: 0, ItemRemark1: String, AccountNoItem: String, AcAccountDepartmentID: String } ] } ], ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }