GET purchase-orders/{purchaseOrderID}
Returns information about the Purchase Order with the given Purchase Order ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
purchaseOrderID | integer | Required |
Body Parameters
None.
Response Information
Resource Description
Returns information about the Purchase Order with the given Purchase Order ID
PurchaseOrderModelName | Description | Type | Additional information |
---|---|---|---|
PurchaseOrderID | ID of the purchase Order | integer | None. |
PurchaseOrderGuid | Unique GIUD of the Purchase Order | globally unique identifier | None. |
User | User who created the Purchase Order | UserBaseModel | None. |
PurchaseOrderReference | StoreFeeder user facing reference number for the Purchase Order | string | None. |
DateRaised | Date the Purchase Order was originally raised | date | None. |
Supplier | Supplier that the Purchase Order is for | PurchaseOrderSupplierModel | None. |
Warehouse | Warehouse that the Purchase Order is for | WarehouseBaseModel | None. |
DateDue | Date that the Purchase Order is due to be delivered | date | None. |
PurchaseOrderStatus | Status of the Purchase Order | PurchaseOrderStatuses | None. |
DeliveryCost | Delivery charge for the Purchase Order | decimal number | None. |
Subtotal | Subtotal of the Purchase Order (i.e. total product cost and shipping less tax) | decimal number | None. |
TotalVat | Total VAT for the purchase order | decimal number | None. |
Total | Total cost of the purchase order including shipping and tax. | decimal number | None. |
Currency | Currency that the purchase order is created in | CurrencyBaseModel | None. |
DateSent | The Date the Purchase Order was sent to the Supplier | date | None. |
PaymentReference | The Payment Reference | string | None. |
PurchaseOrderLines | List of Purchase Order Lines contained in the purchase order. | Collection of PurchaseOrderLineModel | None. |
UpdatedDate | The date the purchase order was last updated. | date | None. |
Response Formats
application/json, text/json
Sample:
{ "PurchaseOrderID": 123, "PurchaseOrderGuid": "cea288d4-fbc7-4bff-ba1d-782492a527eb", "User": { "UserID": 9, "UserName": "Johnny UserMan" }, "PurchaseOrderReference": "123_abc", "DateRaised": "2024-10-30T06:00:50.1012664+00:00", "Supplier": { "SupplierCode": "exSup", "SuppliersReference": "SuppliersReference", "Currency": { "CurrencyID": 4, "CurrencyCode": "GBP", "CurrencyName": "British Pound", "Symbol": "£" }, "SupplierID": 2, "Name": "Example Supplier" }, "Warehouse": { "WarehouseName": "Demo Warehouse", "WarehouseGuid": "837e81f5-b34a-4444-9671-8c62cff46a3a", "WarehouseID": 78 }, "DateDue": "2024-11-01T06:00:50.1012664+00:00", "PurchaseOrderStatus": "SentToSupplier", "DeliveryCost": 5.99, "Subtotal": 15.99, "TotalVat": 4.67, "Total": 25.99, "Currency": { "CurrencyID": 4, "CurrencyCode": "GBP", "CurrencyName": "UK Pound", "Symbol": "£" }, "DateSent": "2024-10-30T06:20:50.1012664+00:00", "PaymentReference": "Example Reference", "PurchaseOrderLines": [ { "PurchaseOrderLineID": 789, "ProductID": 1, "ProductSKU": "ABC", "QtyOrdered": 10, "QtyReceived": 0, "PurchaseOrderDetailsStatus": "AwaitingProduct", "SinglePrice": 1.99, "TaxRate": 20.0, "LineVat": 1.78, "LineTotal": 19.99, "DeliveryStatusID": 1, "DeliveryStatus": "Pending", "QtyWrittenOff": 0.0, "CartonQty": 10, "AddedByUserID": 1, "BookedInByUserID": 1, "TotalUnitsOrdered": 10, "TotalUnitsReceived": 0, "TotalUnitsWrittenOff": 0 } ], "UpdatedDate": "2024-10-30T06:00:50.1012664Z" }