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

jobs_reference_back_office

Embedded entity "jobs" using ERP PK when adding/updating

string

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs

Embedded entity "jobs" using ERP PK when adding/updating

jobs

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_company_code

Embedded entity "company" for the supplier using ERP PK when adding/updating

string
supplier_company

Embedded entity "company" for supplier using ERP PK when adding/updating

company
user_id

Creator of the purchase order

globally unique identifier
user_code

Embedded entity "user" for creator using ERP PK when adding/updating purchase_order

string
user

Embedded entity "user" for creator using node when adding/updating purchase_order

user
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
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
approved_by_user_code

Embedded entity "user" for approver using ERP PK when adding/updating purchase_order

string
approved_by_user

Embedded entity "user" for approver using node when adding/updating purchase_order

user
technical_user_id

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

globally unique identifier
technical_user_code

Embedded entity "user" for technical user using ERP PK when adding/updating purchase_order

string
technical_user

Embedded entity "user" for technical user using node when adding/updating purchase_order

user
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

purchase_order_status_code

Foreign key to purchase_order_status using code. Use "Approved","SentToSupplier","Cancelled" or "Delivered"

string

Optionally required : purchase_order_status_id or purchase_order_status_code must be provided

article_stock_location_id

Stock location that will receive the articles

globally unique identifier
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": "dd161aed-2a0f-41ce-bba7-0d2136881114",
  "id2": 2,
  "jobs_id": "dcaa1c90-6f9f-4bcb-89e0-8db1eda421dc",
  "jobs_reference_back_office": "sample string 4",
  "supplier_company_id": "51803811-ba8f-4f3b-a66b-bc03838a8c14",
  "supplier_company_code": "sample string 6",
  "user_id": "43643e10-cafd-44e2-b791-66490f552e4f",
  "user_code": "sample string 8",
  "description": "sample string 9",
  "memo": "sample string 10",
  "total_lines": 11,
  "date_create": "2025-04-02T07:45:02.6054588+00:00",
  "date_update": "2025-04-02T07:45:02.6054588+00:00",
  "date_delivery": "2025-04-02T07:45:02.6054588+00:00",
  "confirmed_date_delivery": "2025-04-02T07:45:02.6054588+00:00",
  "delivery_db_address_id": "a1cbd64d-b5cf-4a72-b6c6-b0cb120fafc8",
  "approved_by_user_id": "26af6438-aa99-4482-9fd6-0977359d5f58",
  "approved_by_user_code": "sample string 18",
  "technical_user_id": "1faf1cf2-d9a0-4d21-b7b1-064c46965773",
  "technical_user_code": "sample string 20",
  "purchase_order_status_id": "460ff04f-e1c1-4c38-b54a-6b4be4150a3a",
  "purchase_order_status_code": "sample string 22",
  "article_stock_location_id": "83d41485-1427-4b47-9fd4-129560095025",
  "is_pickup": true,
  "reference_back_office": "sample string 25",
  "modified_dateutc": "2025-04-02T07:45:02.6054588+00:00"
}