Retrieves the purchase order with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

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

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

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

boolean
sent_by_xml

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

string
article_stock_location_id

Stock location that will receive the articles

 globally unique identifier
webshop_reference

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": "281eac9e-d139-4c31-8ffa-968d754229e0",
  "id2": 2,
  "jobs_id": "b6f558eb-3c9b-4839-9668-27c4d051973a",
  "supplier_company_id": "3ac94168-51a7-4d96-be12-594f2acbc181",
  "supplier_contact_id": "9086fa7b-6e68-4b06-9318-f36720d0639c",
  "user_id": "1fc973af-a043-4018-862d-e356eb5e3b5d",
  "description": "sample string 7",
  "memo": "sample string 8",
  "total_lines": 9,
  "reference": "sample string 10",
  "date_create": "2026-06-16T21:21:16.3435868+00:00",
  "date_update": "2026-06-16T21:21:16.3435868+00:00",
  "date_delivery": "2026-06-16T21:21:16.3435868+00:00",
  "confirmed_date_delivery": "2026-06-16T21:21:16.3435868+00:00",
  "delivery_db_address_id": "9a2b1853-df43-44bb-83ce-a7785e27a1ef",
  "approved_by_user_id": "fd1ad0e5-d1d9-4dfd-83bb-7bc4a8744fb3",
  "technical_user_id": "c56435a4-0375-4d8e-8b67-bf576131e96b",
  "sent_by_email": true,
  "sent_by_xml": true,
  "purchase_order_status_id": "ee4097df-11e8-4062-aa19-b857a7131631",
  "po_status": "sample string 21",
  "article_stock_location_id": "bf01f93c-393e-466b-aaf6-792736ad201d",
  "webshop_reference": "sample string 23",
  "is_pickup": true,
  "reference_back_office": "sample string 25",
  "modified_dateutc": "2026-06-16T21:21:16.3435868+00:00"
}

application/xml, text/xml

Sample: 
<purchase_order xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <approved_by_user_id>fd1ad0e5-d1d9-4dfd-83bb-7bc4a8744fb3</approved_by_user_id>
  <article_stock_location_id>bf01f93c-393e-466b-aaf6-792736ad201d</article_stock_location_id>
  <confirmed_date_delivery>2026-06-16T21:21:16.343Z</confirmed_date_delivery>
  <date_create>2026-06-16T21:21:16.343Z</date_create>
  <date_delivery>2026-06-16T21:21:16.343Z</date_delivery>
  <date_update>2026-06-16T21:21:16.343Z</date_update>
  <delivery_db_address_id>9a2b1853-df43-44bb-83ce-a7785e27a1ef</delivery_db_address_id>
  <description>sample string 7</description>
  <id>281eac9e-d139-4c31-8ffa-968d754229e0</id>
  <id2>2</id2>
  <is_pickup>true</is_pickup>
  <jobs_id>b6f558eb-3c9b-4839-9668-27c4d051973a</jobs_id>
  <memo>sample string 8</memo>
  <modified_dateutc>2026-06-16T21:21:16.343Z</modified_dateutc>
  <po_status>sample string 21</po_status>
  <purchase_order_status_id>ee4097df-11e8-4062-aa19-b857a7131631</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>3ac94168-51a7-4d96-be12-594f2acbc181</supplier_company_id>
  <supplier_contact_id>9086fa7b-6e68-4b06-9318-f36720d0639c</supplier_contact_id>
  <technical_user_id>c56435a4-0375-4d8e-8b67-bf576131e96b</technical_user_id>
  <total_lines>9</total_lines>
  <user_id>1fc973af-a043-4018-862d-e356eb5e3b5d</user_id>
  <webshop_reference>sample string 23</webshop_reference>
</purchase_order>