# purchaseOrder resource type
Represents a purchase order in Business Central.
> NOTE
> For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central<../enabling-apis-for-dynamics-nav>.
## Methods
Method|Return Type|Description
../api/dynamics_purchaseorder_get|purchaseOrder|Gets a purchase order object.
../api/dynamics_purchaseorder_delete|none|Deletes a purchase order object.
POST purchaseOrder<../api/dynamics_purchaseorder_create>|purchaseOrder|Creates a purchase order object.
PATCH purchaseOrder<../api/dynamics_purchaseorder_update>|purchaseOrder|Updates a purchase order object.
## Bound actions
The purchaseOrder resource type offers a bound action called receiveAndInvoice, which receives and invoices the corresponding purchaseOrder batch.
This is illustrated in the following example:
`RECEIVEANDINVOICE https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/purchaseOrders({id})/Microsoft.NAV.receiveAndInvoice`
The response has no content; the response code is 204.
## Navigation
Navigation|Return Type|Description
dynamics_vendor|vendor|Gets the vendor of the purchaseOrder.
dynamics_dimensionvalue|dimensionValue|Gets the dimensionvalue of the purchaseOrder.
dynamics_currency|currency|Gets the currency of the purchaseOrder.
dynamics_paymentterm|paymentTerm|Gets the paymentterm of the purchaseOrder.
dynamics_shipmentmethod|shipmentMethod|Gets the shipmentmethod of the purchaseOrder.
dynamics_purchaseorderline|purchaseOrderLines|Gets the purchaseorderlines of the purchaseOrder.
dynamics_attachment|attachments|Gets the attachments of the purchaseOrder.
dynamics_dimensionsetline|dimensionSetLines|Gets the dimensionsetlines of the purchaseOrder.
dynamics_documentattachment|documentAttachments|Gets the documentattachments of the purchaseOrder.
dynamics_pdfdocument|pdfDocument|Gets the pdfDocument of the purchaseOrder.
## Properties
Property|Type|Description
id|GUID|The unique ID of the purchase order. Non-editable.
number|string|Specifies the number of the purchase order.
orderDate|date|The order date.
postingDate|date|The date that the purchase order is posted.
vendorId|GUID|The unique ID of vendor.
vendorNumber|string|Specifies vendor's number.
vendorName|string|Specifies vendor's name.
payToName|string|Pay to name of the purchase order.
payToVendorId|GUID|Pay to vendor id.
payToVendorNumber|string|Pay to vendor number.
shipToName|string|Ship to name.
shipToContact|string|Ship to contact.
buyFromAddressLine1|string|Buy from address line 1.
buyFromAddressLine2|string|Buy from address line 2.
buyFromCity|string|Buy from city.
buyFromCountry|string|Buy from country.
buyFromState|string|Buy from state.
buyFromPostCode|string|Buy from post code.
payToAddressLine1|string|Pay to address line 1.
payToAddressLine2|string|Pay to address line 2.
payToCity|string|Pay to city.
payToCountry|string|Pay to country.
payToState|string|Pay to state.
payToPostCode|string|Pay to post code.
shipToAddressLine1|string|Ship to address line 1.
shipToAddressLine2|string|Ship to address line 2.
shipToCity|string|Ship to city.
shipToCountry|string|Ship to country.
shipToState|string|Ship to state.
shipToPostCode|string|Ship to post code.
shortcutDimension1Code|string|The code for shortcut dimension 1.
shortcutDimension2Code|string|The code for shortcut dimension 2.
currencyId|GUID|Specifies which currency the purchase order uses.
currencyCode|string|The default currency code for the purchase order.
pricesIncludeTax|boolean|Specifies whether the prices include Tax or not. Read-Only.
paymentTermsId|GUID|Specifies which payment term the purchase order uses.
shipmentMethodId|GUID|Specifies which shipment method the purchase order uses.
purchaser|string|The purchaser in the purchase order.
requestedReceiptDate|date|The date the receipt was requested.
discountAmount|decimal|The purchase order discount amount.
discountAppliedBeforeTax|boolean|Specifies whether the discount is applied before tax.
totalAmountExcludingTax|decimal|The total amount excluding tax. Read-Only.
totalTaxAmount|decimal|The total tax amount for the purchase order. Read-Only.
totalAmountIncludingTax|decimal|The total amount including tax. Read-Only.
fullyReceived|boolean|Specifies whether the purchase order has been fully received.
status|NAV.purchaseOrderEntityBufferStatus|The status of the purchase order. It can be "Draft", "In Review" or "Open".
lastModifiedDateTime|datetime|The last datetime the purchase order was modified. Read-Only.
## JSON representation
Here's a JSON representation of the purchaseOrder resource.
```json
{
    "id": "GUID",
    "number": "string",
    "orderDate": "date",
    "postingDate": "date",
    "vendorId": "GUID",
    "vendorNumber": "string",
    "vendorName": "string",
    "payToName": "string",
    "payToVendorId": "GUID",
    "payToVendorNumber": "string",
    "shipToName": "string",
    "shipToContact": "string",
    "buyFromAddressLine1": "string",
    "buyFromAddressLine2": "string",
    "buyFromCity": "string",
    "buyFromCountry": "string",
    "buyFromState": "string",
    "buyFromPostCode": "string",
    "payToAddressLine1": "string",
    "payToAddressLine2": "string",
    "payToCity": "string",
    "payToCountry": "string",
    "payToState": "string",
    "payToPostCode": "string",
    "shipToAddressLine1": "string",
    "shipToAddressLine2": "string",
    "shipToCity": "string",
    "shipToCountry": "string",
    "shipToState": "string",
    "shipToPostCode": "string",
    "shortcutDimension1Code": "string",
    "shortcutDimension2Code": "string",
    "currencyId": "GUID",
    "currencyCode": "string",
    "pricesIncludeTax": "boolean",
    "paymentTermsId": "GUID",
    "shipmentMethodId": "GUID",
    "purchaser": "string",
    "requestedReceiptDate": "date",
    "discountAmount": "decimal",
    "discountAppliedBeforeTax": "boolean",
    "totalAmountExcludingTax": "decimal",
    "totalTaxAmount": "decimal",
    "totalAmountIncludingTax": "decimal",
    "fullyReceived": "boolean",
    "status": "NAV.purchaseOrderEntityBufferStatus",
    "lastModifiedDateTime": "datetime"
}
```
## Related information
../api/dynamics_purchaseorder_get
../api/dynamics_purchaseorder_delete
POST purchaseOrder<../api/dynamics_purchaseorder_create>
PATCH purchaseOrder<../api/dynamics_purchaseorder_update>

Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseorder, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact. https://jonas-paprotka.de/docs/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseorder/
