{"title":"purchaseOrder resource type","url":"https://jonas-paprotka.de/docs/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseorder/","by":"JOP-AL","license":"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.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseorder","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"A purchase order object in Dynamics 365 Business Central.","date":"2026-08-21","meta":{"topic":"reference"},"outline":[{"level":1,"title":"purchaseOrder resource type","slug":"purchaseorder-resource-type","at":0,"chars":6363},{"level":2,"title":"Methods","slug":"methods","at":237,"chars":404},{"level":2,"title":"Bound actions","slug":"bound-actions","at":641,"chars":429},{"level":2,"title":"Navigation","slug":"navigation","at":1070,"chars":862},{"level":2,"title":"Properties","slug":"properties","at":1932,"chars":2609},{"level":2,"title":"JSON representation","slug":"json-representation","at":4541,"chars":1614},{"level":2,"title":"Related information","slug":"related-information","at":6155,"chars":208}],"text":"# purchaseOrder resource type\nRepresents a purchase order in Business Central.\n> NOTE\n> For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central<../enabling-apis-for-dynamics-nav>.\n## Methods\nMethod|Return Type|Description\n../api/dynamics_purchaseorder_get|purchaseOrder|Gets a purchase order object.\n../api/dynamics_purchaseorder_delete|none|Deletes a purchase order object.\nPOST purchaseOrder<../api/dynamics_purchaseorder_create>|purchaseOrder|Creates a purchase order object.\nPATCH purchaseOrder<../api/dynamics_purchaseorder_update>|purchaseOrder|Updates a purchase order object.\n## Bound actions\nThe purchaseOrder resource type offers a bound action called receiveAndInvoice, which receives and invoices the corresponding purchaseOrder batch.\nThis is illustrated in the following example:\n`RECEIVEANDINVOICE https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/purchaseOrders({id})/Microsoft.NAV.receiveAndInvoice`\nThe response has no content; the response code is 204.\n## Navigation\nNavigation|Return Type|Description\ndynamics_vendor|vendor|Gets the vendor of the purchaseOrder.\ndynamics_dimensionvalue|dimensionValue|Gets the dimensionvalue of the purchaseOrder.\ndynamics_currency|currency|Gets the currency of the purchaseOrder.\ndynamics_paymentterm|paymentTerm|Gets the paymentterm of the purchaseOrder.\ndynamics_shipmentmethod|shipmentMethod|Gets the shipmentmethod of the purchaseOrder.\ndynamics_purchaseorderline|purchaseOrderLines|Gets the purchaseorderlines of the purchaseOrder.\ndynamics_attachment|attachments|Gets the attachments of the purchaseOrder.\ndynamics_dimensionsetline|dimensionSetLines|Gets the dimensionsetlines of the purchaseOrder.\ndynamics_documentattachment|documentAttachments|Gets the documentattachments of the purchaseOrder.\ndynamics_pdfdocument|pdfDocument|Gets the pdfDocument of the purchaseOrder.\n## Properties\nProperty|Type|Description\nid|GUID|The unique ID of the purchase order. Non-editable.\nnumber|string|Specifies the number of the purchase order.\norderDate|date|The order date.\npostingDate|date|The date that the purchase order is posted.\nvendorId|GUID|The unique ID of vendor.\nvendorNumber|string|Specifies vendor's number.\nvendorName|string|Specifies vendor's name.\npayToName|string|Pay to name of the purchase order.\npayToVendorId|GUID|Pay to vendor id.\npayToVendorNumber|string|Pay to vendor number.\nshipToName|string|Ship to name.\nshipToContact|string|Ship to contact.\nbuyFromAddressLine1|string|Buy from address line 1.\nbuyFromAddressLine2|string|Buy from address line 2.\nbuyFromCity|string|Buy from city.\nbuyFromCountry|string|Buy from country.\nbuyFromState|string|Buy from state.\nbuyFromPostCode|string|Buy from post code.\npayToAddressLine1|string|Pay to address line 1.\npayToAddressLine2|string|Pay to address line 2.\npayToCity|string|Pay to city.\npayToCountry|string|Pay to country.\npayToState|string|Pay to state.\npayToPostCode|string|Pay to post code.\nshipToAddressLine1|string|Ship to address line 1.\nshipToAddressLine2|string|Ship to address line 2.\nshipToCity|string|Ship to city.\nshipToCountry|string|Ship to country.\nshipToState|string|Ship to state.\nshipToPostCode|string|Ship to post code.\nshortcutDimension1Code|string|The code for shortcut dimension 1.\nshortcutDimension2Code|string|The code for shortcut dimension 2.\ncurrencyId|GUID|Specifies which currency the purchase order uses.\ncurrencyCode|string|The default currency code for the purchase order.\npricesIncludeTax|boolean|Specifies whether the prices include Tax or not. Read-Only.\npaymentTermsId|GUID|Specifies which payment term the purchase order uses.\nshipmentMethodId|GUID|Specifies which shipment method the purchase order uses.\npurchaser|string|The purchaser in the purchase order.\nrequestedReceiptDate|date|The date the receipt was requested.\ndiscountAmount|decimal|The purchase order discount amount.\ndiscountAppliedBeforeTax|boolean|Specifies whether the discount is applied before tax.\ntotalAmountExcludingTax|decimal|The total amount excluding tax. Read-Only.\ntotalTaxAmount|decimal|The total tax amount for the purchase order. Read-Only.\ntotalAmountIncludingTax|decimal|The total amount including tax. Read-Only.\nfullyReceived|boolean|Specifies whether the purchase order has been fully received.\nstatus|NAV.purchaseOrderEntityBufferStatus|The status of the purchase order. It can be \"Draft\", \"In Review\" or \"Open\".\nlastModifiedDateTime|datetime|The last datetime the purchase order was modified. Read-Only.\n## JSON representation\nHere's a JSON representation of the purchaseOrder resource.\n```json\n{\n    \"id\": \"GUID\",\n    \"number\": \"string\",\n    \"orderDate\": \"date\",\n    \"postingDate\": \"date\",\n    \"vendorId\": \"GUID\",\n    \"vendorNumber\": \"string\",\n    \"vendorName\": \"string\",\n    \"payToName\": \"string\",\n    \"payToVendorId\": \"GUID\",\n    \"payToVendorNumber\": \"string\",\n    \"shipToName\": \"string\",\n    \"shipToContact\": \"string\",\n    \"buyFromAddressLine1\": \"string\",\n    \"buyFromAddressLine2\": \"string\",\n    \"buyFromCity\": \"string\",\n    \"buyFromCountry\": \"string\",\n    \"buyFromState\": \"string\",\n    \"buyFromPostCode\": \"string\",\n    \"payToAddressLine1\": \"string\",\n    \"payToAddressLine2\": \"string\",\n    \"payToCity\": \"string\",\n    \"payToCountry\": \"string\",\n    \"payToState\": \"string\",\n    \"payToPostCode\": \"string\",\n    \"shipToAddressLine1\": \"string\",\n    \"shipToAddressLine2\": \"string\",\n    \"shipToCity\": \"string\",\n    \"shipToCountry\": \"string\",\n    \"shipToState\": \"string\",\n    \"shipToPostCode\": \"string\",\n    \"shortcutDimension1Code\": \"string\",\n    \"shortcutDimension2Code\": \"string\",\n    \"currencyId\": \"GUID\",\n    \"currencyCode\": \"string\",\n    \"pricesIncludeTax\": \"boolean\",\n    \"paymentTermsId\": \"GUID\",\n    \"shipmentMethodId\": \"GUID\",\n    \"purchaser\": \"string\",\n    \"requestedReceiptDate\": \"date\",\n    \"discountAmount\": \"decimal\",\n    \"discountAppliedBeforeTax\": \"boolean\",\n    \"totalAmountExcludingTax\": \"decimal\",\n    \"totalTaxAmount\": \"decimal\",\n    \"totalAmountIncludingTax\": \"decimal\",\n    \"fullyReceived\": \"boolean\",\n    \"status\": \"NAV.purchaseOrderEntityBufferStatus\",\n    \"lastModifiedDateTime\": \"datetime\"\n}\n```\n## Related information\n../api/dynamics_purchaseorder_get\n../api/dynamics_purchaseorder_delete\nPOST purchaseOrder<../api/dynamics_purchaseorder_create>\nPATCH purchaseOrder<../api/dynamics_purchaseorder_update>"}