Retrieves all purchase order lines, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of purchase order lines.
purchase_order_details| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| purchase_order_id |
Foreign key of the purchase_order |
globally unique identifier |
Optionally required : purchase_order_id, purchase_order_reference or purchase_order must be provided |
| article_id |
Foreign key of article |
globally unique identifier |
Optionally required : article_id, article_code or article must be provided |
| line_number |
Line Number, auto filled with (Highest+1) if value is 0/null |
integer | |
| code |
Code of the article (auto filled if empty) |
string |
Max length: 255 |
| supplier_code |
Code of the supplier for this article |
string |
Max length: 255 |
| name |
Article Name (will be auto filled if article.name+description are empty) |
string |
Max length: 255 |
| description |
Article description (will be auto filled by article.short_description if name+description are empty) |
string |
Max length: 255 |
| price |
Unit Price |
decimal number |
Matching regular expression pattern: ^[0-9]\d*(\.\d+)?$ Range: inclusive between 0.1 and 1.79769313486232E+308 |
| quantity |
Quantity |
decimal number |
Required Range: inclusive between 0.1 and 1.79769313486232E+308 |
| unit |
Unit of measure the ordered is expressed in. |
string | |
| memo |
Line memo/remark |
string | |
| cost_price |
Unit Cost Price (statistic purpose) |
decimal number |
Matching regular expression pattern: ^[0-9]\d*(\.\d+)?$ |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| is_dummy |
Indicates this is a placeholder/dummy line (e.g. a manually keyed-in item) rather than a real catalog article. |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "8b7e1452-7886-49ed-99ba-5875d79c8832",
"purchase_order_id": "8bd0dbda-82f8-4112-acd7-0f30fe98633f",
"article_id": "e7cd24c0-0803-420e-ae3b-3b40292c8b09",
"line_number": 4,
"code": "sample string 5",
"supplier_code": "sample string 6",
"name": "sample string 7",
"description": "sample string 8",
"price": 9.0,
"quantity": 10.0,
"unit": "sample string 11",
"memo": "sample string 12",
"cost_price": 13.0,
"reference_back_office": "sample string 14",
"is_dummy": true,
"modified_dateutc": "2026-09-16T10:14:45.3609014+00:00"
}
application/xml, text/xml
<purchase_order_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <article_id>e7cd24c0-0803-420e-ae3b-3b40292c8b09</article_id> <code>sample string 5</code> <cost_price>13</cost_price> <description>sample string 8</description> <id>8b7e1452-7886-49ed-99ba-5875d79c8832</id> <is_dummy>true</is_dummy> <line_number>4</line_number> <memo>sample string 12</memo> <modified_dateutc>2026-09-16T10:14:45.360Z</modified_dateutc> <name>sample string 7</name> <price>9</price> <purchase_order_id>8bd0dbda-82f8-4112-acd7-0f30fe98633f</purchase_order_id> <quantity>10</quantity> <reference_back_office>sample string 14</reference_back_office> <supplier_code>sample string 6</supplier_code> <unit>sample string 11</unit> </purchase_order_details>