v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB

PurchaseOrder

Change_PurchaseOrderStatus

Change purchase order status. Can change from: PENDING to OPEN, which will populate Due (OnOrder) values in stock levels, OPEN to DELIVERED, which will consolidate Due values in stock levels PARTIAL to DELIVERED, which will consolidate Due values in stock levels Permissions Required: GlobalPermissions.Inventory.PurchaseOrder.EditPurchaseOrderNode Rate limit: 150 / minute

post/api/PurchaseOrder/Change_PurchaseOrderStatus

Request body

Example request

{
  "changeStatusParameter": {
    "pkPurchaseId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

pkPurchaseIDstring uuid

Unique identifier for the purchase order. You have to use this ID for all updates to the PO

fkSupplierIdstring uuid

Unique identifier for the supplier. Empty Guid is default supplier. Otherwise use Supplier API to get the names and additional data for the supplier

fkLocationIdstring uuid

Unique idenfidier of the location where the PO is expected to be delivered to. Empty Guid is default location. Use Locations API methods to get the names and additional details for the locations

ExternalInvoiceNumberstring

Purchase order reference number

Status'PENDING' | 'OPEN' | 'PARTIAL' | 'DELIVERED'

Purchase order status. PENDING - purchase order can be changed, not yet affecting stock levels OPEN - purchase order is created and stock levels Due are reflected PARTIAL - partially delivered DELIVERED - fully delivered

Currencystring

Currency of the monetary values in the purchase order

SupplierReferenceNumberstring

Supplier reference number for the purchase order

Lockedboolean

Identified whether the PO is locked. This is for external application use only.

UnitAmountTaxIncludedTypeinteger

Unit amount includes,exclud or no tax. 0 - Tax Exclusive cost, 1 - Cost Inclusive of tax, 2 - No Tax

LineCountinteger

Number of items in the purchase order

DeliveredLinesCountinteger

Count of all purchase order lines which are delivered (lines where some but not all of the stock has been received are counted as undelivered)

DateOfPurchasestring date-time

DateTime of the purchase order UTC

DateOfDeliverystring date-time

DateTime of the purchase order delivered, will be set to DateOfPurchase until the PO is fully delivered UTC

QuotedDeliveryDatestring date-time

DateTime of the purchase order qouted/expected delivery date UTC

PostagePaidnumber double

DEPRECIATED Use additional costs with Shipping flag to record shipping costs. This field remains available in the API for backward compatibility and acts pretty much like an additional cost item with type id = 0

TotalCostnumber double

Total purchase price of the purchase order. Calculated from all purchase order items including tax and postage.

taxPaidnumber double

Total tax of the purchase order. Calculated from all purchase order items (excludes postage).

ShippingTaxRatenumber double

ConversionRatenumber double

Conversion rate of the purchase order currency. When PO is delivered Stock Value will be multipled by this conversion rate. For example if your system currency is GBP and Purchase order is in EUR the conversion rate is 0.81.

ConvertedShippingCostnumber double

Total shipping cost of the purchase order, converted to system currency

ConvertedShippingTaxnumber double

Total shipping cost tax of the purchase order, converted to system currency

ConvertedOtherCostnumber double

Total amount of additional costs of the purchase order, converted to system currency

ConvertedOtherTaxnumber double

Total tax amount of additional costs of the purchase order, converted to system currency

ConvertedGrandTotalnumber double

Total amount of the purchase order, converted to system currency

Example response

{
  "pkPurchaseID": "00000000-0000-0000-0000-000000000000",
  "fkSupplierId": "00000000-0000-0000-0000-000000000000",
  "fkLocationId": "00000000-0000-0000-0000-000000000000"
}