Create purchaseOrders

Creates a purchase order in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/purchaseOrders({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply a JSON representation of a purchaseOrder object.

Response

If successful, this method returns 201 Created response code and a purchaseOrder object in the response body.

Example

Request

Here is an example of the request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseOrders
Content-type: application/json
{
   "orderDate": "2021-01-01",
   "postingDate": "2021-01-01",
   "dueDate": "2021-01-01",
   "vendorId": "",
   "vendorNumber": "20000",
   "payToVendorId": "Evan McIntosh",
   "payToVendorNumber": "20000",
   "shipToName": "First Up Consultants",
   "shipToContact": "Evan McIntosh",
   "buyFromAddressLine1": "100 Day Drive",
   "buyFromAddressLine2": "",
   "buyFromCity": "Chicago",
   "buyFromCountry": "US",
   "buyFromState": "IL",
   "buyFromPostCode": "61236",
   "shipToAddressLine1": "100 Day Drive",
   "shipToAddressLine2": "",
   "shipToCity": "Chicago",
   "shipToCountry": "US",
   "shipToState": "IL",
   "shipToPostCode": "61236",
   "currencyId": "00000000-0000-0000-0000-000000000000",
   "currencyCode": "USD",
   "pricesIncludeTax": false,
   "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
   "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
   "purchaser": "First Up Consultants",
   "requestedReceiptDate": "2021-01-01",
   "discountAmount": 0
}

Response

Here is an example of the response.

HTTP/1.1 201 Created
Content-type: application/json
{
   "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
   "number": "108001",
   "orderDate": "2021-01-01",
   "postingDate": "2021-01-01",
   "dueDate": "2021-01-01",
   "vendorId": "",
   "vendorNumber": "20000",
   "vendorName": "First Up Consultants",
   "payToName": "First Up Consultants",
   "payToVendorId": "Evan McIntosh",
   "payToVendorNumber": "20000",
   "shipToName": "First Up Consultants",
   "shipToContact": "Evan McIntosh",
   "buyFromAddressLine1": "100 Day Drive",
   "buyFromAddressLine2": "",
   "buyFromCity": "Chicago",
   "buyFromCountry": "US",
   "buyFromState": "IL",
   "buyFromPostCode": "61236",
   "shipToAddressLine1": "100 Day Drive",
   "shipToAddressLine2": "",
   "shipToCity": "Chicago",
   "shipToCountry": "US",
   "shipToState": "IL",
   "shipToPostCode": "61236",
   "payToAddressLine1": "100 Day Drive",
   "payToAddressLine2": "",
   "payToCity": "Chicago",
   "payToCountry": "US",
   "payToState": "IL",
   "payToPostCode": "61236",
   "currencyId": "00000000-0000-0000-0000-000000000000",
   "currencyCode": "USD",
   "pricesIncludeTax": false,
   "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
   "shipmentMethodId": "93f5638a-55e3-jk22-aa32-211d3a2fdce5",
   "purchaser": "First Up Consultants",
   "requestedReceiptDate": "2021-01-01",
   "discountAmount": 0,
   "discountAppliedBeforeTax": false,
   "totalAmountExcludingTax": 0,
   "totalTaxAmount": 0,
   "totalAmountIncludingTax": 0,
   "fullyReceived": false,
   "status": "Draft",
   "lastModifiedDateTime": "2021-01-01T00:26:53.793Z"
}

Tips for working with the APIs
purchaseOrder
GET purchaseOrder
DELETE purchaseOrder
PATCH purchaseOrder