Retrieves the purchase order with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The purchase order id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the purchase order, or 404 Not Found if it doesn't exist.

purchase_order
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
id2

Internal ID (numeric) automatically filled if empty

 integer
jobs_id

Foreign key to Jobs

 globally unique identifier

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided
supplier_company_id

Foreign key to company, contains the supplier

 globally unique identifier
supplier_contact_id

Foreign key of the contact at the supplier company to reach about this purchase order.

 globally unique identifier
user_id

Creator of the purchase order

 globally unique identifier
description

Description of the purchase order

 string

Max length: 4000
memo

Memo, remark

 string
total_lines

Number of lines, automatically filled when adding/updating/deleting lines

 integer
reference

Free-text reference for this purchase order (e.g. the supplier's order confirmation number).

 string
date_create

Creation date

 date
date_update

Last update date

 date
date_delivery

Estimated date of delivery

 date
confirmed_date_delivery

Date of the delivery

 date
delivery_db_address_id

If Delivery and no picking, AddressID of the company (if not the main)

 globally unique identifier
approved_by_user_id

If approval was needed, which user approves it

 globally unique identifier
technical_user_id

User to contact if case of technical question about the purchase order

 globally unique identifier
sent_by_email

Indicates this purchase order has been sent to the supplier by email.

 boolean
sent_by_xml

Indicates this purchase order has been sent to the supplier via XML/EDI integration.

 boolean
purchase_order_status_id

Foreign key to purchase_order_status

 globally unique identifier

Optionally required : purchase_order_status_id or purchase_order_status_code must be provided
po_status

Display text of the purchase order status (denormalized copy of the status referenced by ).

 string
article_stock_location_id

Stock location that will receive the articles

 globally unique identifier
webshop_reference

Reference/order number from the supplier's webshop, when the purchase order was placed through one.

 string
is_pickup

If pickup, the technician will go himself to the supplier to take the goods

 boolean
reference_back_office

Field used for Embedded entity (store there your ERP PK)

 string

Max length: 50
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "1d4544bb-8289-47e6-a7b6-26cb7780974d",
  "id2": 2,
  "jobs_id": "aadfe12a-790b-4cfe-b456-25185986d1dd",
  "supplier_company_id": "35d5261e-00fd-4c7f-a7f6-31ff6be95e80",
  "supplier_contact_id": "16f8386b-5197-4611-9187-a0f9f8664696",
  "user_id": "421fe4dd-8339-4d14-bd39-3c476cb7f674",
  "description": "sample string 7",
  "memo": "sample string 8",
  "total_lines": 9,
  "reference": "sample string 10",
  "date_create": "2026-09-16T09:24:05.7972483+00:00",
  "date_update": "2026-09-16T09:24:05.7972483+00:00",
  "date_delivery": "2026-09-16T09:24:05.7972483+00:00",
  "confirmed_date_delivery": "2026-09-16T09:24:05.7972483+00:00",
  "delivery_db_address_id": "b819dc17-b6cb-4ecb-835a-996037b920da",
  "approved_by_user_id": "0a644600-29f7-4aa6-bcd0-b29a8a870a2f",
  "technical_user_id": "a44b4bfd-fa99-4852-8b09-c438b0a2a8b5",
  "sent_by_email": true,
  "sent_by_xml": true,
  "purchase_order_status_id": "4ec1a419-ed1f-454d-9537-323fa1f18893",
  "po_status": "sample string 21",
  "article_stock_location_id": "8c2f6833-3801-4421-b696-e23ef3d0802e",
  "webshop_reference": "sample string 23",
  "is_pickup": true,
  "reference_back_office": "sample string 25",
  "modified_dateutc": "2026-09-16T09:24:05.7972483+00:00"
}

application/xml, text/xml

Sample: 
<purchase_order xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <approved_by_user_id>0a644600-29f7-4aa6-bcd0-b29a8a870a2f</approved_by_user_id>
  <article_stock_location_id>8c2f6833-3801-4421-b696-e23ef3d0802e</article_stock_location_id>
  <confirmed_date_delivery>2026-09-16T09:24:05.797Z</confirmed_date_delivery>
  <date_create>2026-09-16T09:24:05.797Z</date_create>
  <date_delivery>2026-09-16T09:24:05.797Z</date_delivery>
  <date_update>2026-09-16T09:24:05.797Z</date_update>
  <delivery_db_address_id>b819dc17-b6cb-4ecb-835a-996037b920da</delivery_db_address_id>
  <description>sample string 7</description>
  <id>1d4544bb-8289-47e6-a7b6-26cb7780974d</id>
  <id2>2</id2>
  <is_pickup>true</is_pickup>
  <jobs_id>aadfe12a-790b-4cfe-b456-25185986d1dd</jobs_id>
  <memo>sample string 8</memo>
  <modified_dateutc>2026-09-16T09:24:05.797Z</modified_dateutc>
  <po_status>sample string 21</po_status>
  <purchase_order_status_id>4ec1a419-ed1f-454d-9537-323fa1f18893</purchase_order_status_id>
  <reference>sample string 10</reference>
  <reference_back_office>sample string 25</reference_back_office>
  <sent_by_email>true</sent_by_email>
  <sent_by_xml>true</sent_by_xml>
  <supplier_company_id>35d5261e-00fd-4c7f-a7f6-31ff6be95e80</supplier_company_id>
  <supplier_contact_id>16f8386b-5197-4611-9187-a0f9f8664696</supplier_contact_id>
  <technical_user_id>a44b4bfd-fa99-4852-8b09-c438b0a2a8b5</technical_user_id>
  <total_lines>9</total_lines>
  <user_id>421fe4dd-8339-4d14-bd39-3c476cb7f674</user_id>
  <webshop_reference>sample string 23</webshop_reference>
</purchase_order>