Retrieves the purchase order with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
purchase_order| Name | Description | Type | Additional 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
{
"id": "c0ce0a06-9301-425b-bb11-11d08a701f44",
"id2": 2,
"jobs_id": "8fe68054-d2b6-411a-ae7c-d7715c34b712",
"supplier_company_id": "2d5893ff-f8b8-4a6f-ba7c-0f7eeebcb7ea",
"supplier_contact_id": "2398cccd-1bc4-4d68-ae57-a3326b51361d",
"user_id": "23e6563c-88b3-4fe2-abfa-b0dd019f7f61",
"description": "sample string 7",
"memo": "sample string 8",
"total_lines": 9,
"reference": "sample string 10",
"date_create": "2026-03-07T14:52:59.9940778+00:00",
"date_update": "2026-03-07T14:52:59.9940778+00:00",
"date_delivery": "2026-03-07T14:52:59.9940778+00:00",
"confirmed_date_delivery": "2026-03-07T14:52:59.9940778+00:00",
"delivery_db_address_id": "c06af213-c1b2-4e95-b2bb-9d3e36cb2750",
"approved_by_user_id": "49d7685a-29b6-41cf-9eee-5ba0d41fb71f",
"technical_user_id": "ab2b88a7-1a00-4eaf-9330-6b7cb5b40d31",
"sent_by_email": true,
"sent_by_xml": true,
"purchase_order_status_id": "3ad55e36-da65-4c79-9bbe-44c3fd57e6cd",
"po_status": "sample string 21",
"article_stock_location_id": "3fe85e9e-f062-4e0e-879e-3af2157ad8d3",
"webshop_reference": "sample string 23",
"is_pickup": true,
"reference_back_office": "sample string 25",
"modified_dateutc": "2026-03-07T14:52:59.9940778+00:00"
}
application/xml, text/xml
<purchase_order xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <approved_by_user_id>49d7685a-29b6-41cf-9eee-5ba0d41fb71f</approved_by_user_id> <article_stock_location_id>3fe85e9e-f062-4e0e-879e-3af2157ad8d3</article_stock_location_id> <confirmed_date_delivery>2026-03-07T14:52:59.994Z</confirmed_date_delivery> <date_create>2026-03-07T14:52:59.994Z</date_create> <date_delivery>2026-03-07T14:52:59.994Z</date_delivery> <date_update>2026-03-07T14:52:59.994Z</date_update> <delivery_db_address_id>c06af213-c1b2-4e95-b2bb-9d3e36cb2750</delivery_db_address_id> <description>sample string 7</description> <id>c0ce0a06-9301-425b-bb11-11d08a701f44</id> <id2>2</id2> <is_pickup>true</is_pickup> <jobs_id>8fe68054-d2b6-411a-ae7c-d7715c34b712</jobs_id> <memo>sample string 8</memo> <modified_dateutc>2026-03-07T14:52:59.994Z</modified_dateutc> <po_status>sample string 21</po_status> <purchase_order_status_id>3ad55e36-da65-4c79-9bbe-44c3fd57e6cd</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>2d5893ff-f8b8-4a6f-ba7c-0f7eeebcb7ea</supplier_company_id> <supplier_contact_id>2398cccd-1bc4-4d68-ae57-a3326b51361d</supplier_contact_id> <technical_user_id>ab2b88a7-1a00-4eaf-9330-6b7cb5b40d31</technical_user_id> <total_lines>9</total_lines> <user_id>23e6563c-88b3-4fe2-abfa-b0dd019f7f61</user_id> <webshop_reference>sample string 23</webshop_reference> </purchase_order>