---
title: "Get_PurchaseOrder"
method: POST
path: "/api/PurchaseOrder/Get_PurchaseOrder"
tags: ["PurchaseOrder"]
---

# Get_PurchaseOrder

`POST /api/PurchaseOrder/Get_PurchaseOrder`

Get purchase order header and items in one call
<b>Permissions Required: </b> GlobalPermissions.Inventory.PurchaseOrder.ViewPurchaseOrderNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>250</b></span> / minute

## Request body

- PurchaseOrderGetPurchaseOrderRequest
  - `pkPurchaseId` string, uuid — Purchase Order unique identifier

## Response `200`

OK

- PurchaseOrderResponse
  - `NoteCount` integer
  - `PurchaseOrderHeader` PurchaseOrderHeader
    - `ExternalInvoiceNumber` string
    - `Status` 'PENDING' | 'OPEN' | 'PARTIAL' | 'DELIVERED'
    - `Currency` string
    - `SupplierReferenceNumber` string
    - `Locked` boolean
    - `UnitAmountTaxIncludedType` integer
    - `LineCount` integer
    - `DeliveredLinesCount` integer
    - `pkPurchaseID` string, uuid
    - `fkSupplierId` string, uuid
    - `fkLocationId` string, uuid
    - `DateOfPurchase` string, date-time
    - `DateOfDelivery` string, date-time
    - `QuotedDeliveryDate` string, date-time
    - `PostagePaid` number, double
    - `TotalCost` number, double
    - `taxPaid` number, double
    - `ShippingTaxRate` number, double
    - `ConversionRate` number, double
    - `ConvertedShippingCost` number, double
    - `ConvertedShippingTax` number, double
    - `ConvertedOtherCost` number, double
    - `ConvertedOtherTax` number, double
    - `ConvertedGrandTotal` number, double
  - `PurchaseOrderItem` PurchaseOrderItem[]
    - `pkPurchaseItemId` string, uuid
    - `fkStockItemId` string, uuid
    - `StockItemIntId` integer
    - `Quantity` integer
    - `Cost` number, double
    - `Delivered` integer
    - `TaxRate` number, double
    - `Tax` number, double
    - `PackQuantity` integer
    - `PackSize` integer
    - `SKU` string
    - `ItemTitle` string
    - `InventoryTrackingType` integer
    - `IsDeleted` boolean
    - `SortOrder` integer
    - `DimHeight` number, double
    - `DimWidth` number, double
    - `BarcodeNumber` string
    - `DimDepth` number, double
    - `BoundToOpenOrdersItems` integer
    - `BinRack` string
    - `QuantityBoundToOpenOrdersItems` integer
    - `SupplierCode` string
    - `SupplierBarcode` string
    - `SkuGroupIds` integer[]
  - `AdditionalCosts` PurchaseOrderAdditionalCost[]
    - `AdditionalCostTypeIsShippingType` boolean
    - `PurchaseAdditionalCostItemId` integer
    - `AdditionalCostTypeId` integer
    - `Reference` string
    - `SubTotalLineCost` number, double
    - `TaxRate` number, double
    - `Tax` number, double
    - `Currency` string
    - `ConversionRate` number, double
    - `TotalLineCost` number, double
    - `CostAllocation` PurchaseOrderAdditionalCostAllocation[]
      - `CostAllocationId` integer
      - `PurchaseAdditionalCostItemId` integer
      - `PurchaseItemId` string, uuid
      - `AllocationPercentage` number, double
    - `AllocationLocked` boolean
    - `AdditionalCostTypeName` string
    - `AdditionalCostTypeIsPartialAllocation` boolean
    - `Print` boolean
    - `AllocationMethod` 'ByValue' | 'ByCBM'
  - `PaymentStatements` PurchaseOrderPaymentStatement[]
    - `PurchasePaymentStatementId` integer
    - `LineCost` number, double
    - `ConversionRate` number, double
    - `Currency` string
    - `Reference` string
    - `CreationDate` string, date-time
    - `PaymentDate` string, date-time
    - `fkPurchaseAdditionalCostItemId` integer
  - `DeliveredRecords` PurchaseOrderDeliveredRecord[]
    - `fkDeliveryId` integer
    - `pkDeliveryRecordId` integer
    - `fkPurchaseItemId` string, uuid
    - `fkStockLocationId` string, uuid
    - `UnitCost` number, double
    - `DeliveredQuantity` integer
    - `CreatedDateTime` string, date-time
    - `ModifiedDateTime` string, date-time
    - `fkBatchInventoryId` integer

---

[API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)
