Retrieves all purchase orders, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of purchase orders.
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 |
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
{
"id": "07f7df27-a9c6-49db-9794-17512130e5a4",
"id2": 2,
"jobs_id": "11c525be-4f7e-49b7-be6d-c2786f429294",
"supplier_company_id": "2b975767-9118-4c1f-bb33-fbf78fb13580",
"supplier_contact_id": "98c8df57-2f81-46a8-8af0-d988f6788ffa",
"user_id": "095cf181-f9da-4364-aae8-e21de8a595ee",
"description": "sample string 7",
"memo": "sample string 8",
"total_lines": 9,
"reference": "sample string 10",
"date_create": "2026-11-12T14:27:38.9466751+00:00",
"date_update": "2026-11-12T14:27:38.9466751+00:00",
"date_delivery": "2026-11-12T14:27:38.9466751+00:00",
"confirmed_date_delivery": "2026-11-12T14:27:38.9466751+00:00",
"delivery_db_address_id": "3035eb6b-710e-4d2d-b409-f1325ae71de7",
"approved_by_user_id": "f9670aa3-fef6-40fe-9557-00ea8e3b48c2",
"technical_user_id": "bb577af6-f767-40e3-9675-17da9d773ce4",
"sent_by_email": true,
"sent_by_xml": true,
"purchase_order_status_id": "722fdafe-26ee-4daa-80d8-f3e7eb0cc418",
"po_status": "sample string 21",
"article_stock_location_id": "6ba2a58e-d3b0-45af-886d-ecf6a02f7a35",
"webshop_reference": "sample string 23",
"is_pickup": true,
"reference_back_office": "sample string 25",
"modified_dateutc": "2026-11-12T14:27:38.9466751+00:00"
}
application/xml, text/xml
<purchase_order xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <approved_by_user_id>f9670aa3-fef6-40fe-9557-00ea8e3b48c2</approved_by_user_id> <article_stock_location_id>6ba2a58e-d3b0-45af-886d-ecf6a02f7a35</article_stock_location_id> <confirmed_date_delivery>2026-11-12T14:27:38.946Z</confirmed_date_delivery> <date_create>2026-11-12T14:27:38.946Z</date_create> <date_delivery>2026-11-12T14:27:38.946Z</date_delivery> <date_update>2026-11-12T14:27:38.946Z</date_update> <delivery_db_address_id>3035eb6b-710e-4d2d-b409-f1325ae71de7</delivery_db_address_id> <description>sample string 7</description> <id>07f7df27-a9c6-49db-9794-17512130e5a4</id> <id2>2</id2> <is_pickup>true</is_pickup> <jobs_id>11c525be-4f7e-49b7-be6d-c2786f429294</jobs_id> <memo>sample string 8</memo> <modified_dateutc>2026-11-12T14:27:38.946Z</modified_dateutc> <po_status>sample string 21</po_status> <purchase_order_status_id>722fdafe-26ee-4daa-80d8-f3e7eb0cc418</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>2b975767-9118-4c1f-bb33-fbf78fb13580</supplier_company_id> <supplier_contact_id>98c8df57-2f81-46a8-8af0-d988f6788ffa</supplier_contact_id> <technical_user_id>bb577af6-f767-40e3-9675-17da9d773ce4</technical_user_id> <total_lines>9</total_lines> <user_id>095cf181-f9da-4364-aae8-e21de8a595ee</user_id> <webshop_reference>sample string 23</webshop_reference> </purchase_order>