Purchase Order Resource¶
Get Purchase Order¶
HTTP Request
GET /api/purchaseOrders/{id}
📋 Description: Retrieves detailed information about a specific purchase order identified by its unique ID, enabling users to access order status, items, and associated vendor details for effective procurement management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "estimatedCost": "67.08",
9 "purchaseOrderNumber": "string",
10 "initiatedAt": "2019-08-24T14:15:22Z",
11 "initiatedBy": "string",
12 "approvedAt": "2019-08-24T14:15:22Z",
13 "approvedBy": "string",
14 "orderDate": "2019-08-24",
15 "dueDate": "2019-08-24",
16 "supplierId": 0,
17 "supplier": "string",
18 "assetPartOrders": [
19 0
20 ],
21 "purchaseOrderItems": [
22 0
23 ],
24 "purchaseOrderStatusId": 0,
25 "purchaseOrderStatus": "string",
26 "workOrderPriorityId": 0,
27 "workOrderPriority": "string",
28 "assignedUserIds": [
29 0
30 ]
31}
Update Purchase Order¶
HTTP Request
PUT /api/purchaseOrders/{id}
📋 Description: Updates the details of an existing purchase order identified by its unique ID, allowing businesses to modify order information as needed to reflect changes in procurement requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated purchase order details, including item specifications, quantities, and pricing information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "estimatedCost": "67.08",
9 "purchaseOrderNumber": "string",
10 "initiatedAt": "2019-08-24T14:15:22Z",
11 "initiatedBy": "string",
12 "approvedAt": "2019-08-24T14:15:22Z",
13 "approvedBy": "string",
14 "orderDate": "2019-08-24",
15 "dueDate": "2019-08-24",
16 "supplierId": 0,
17 "supplier": "string",
18 "assetPartOrders": [
19 0
20 ],
21 "purchaseOrderItems": [
22 0
23 ],
24 "purchaseOrderStatusId": 0,
25 "purchaseOrderStatus": "string",
26 "workOrderPriorityId": 0,
27 "workOrderPriority": "string",
28 "assignedUserIds": [
29 0
30 ]
31}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Purchase Order¶
HTTP Request
DELETE /api/purchaseOrders/{id}
📋 Description: Deletes a specified purchase order by its unique identifier, ensuring the removal of obsolete or erroneous entries from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Purchase Orders¶
HTTP Request
GET /api/purchaseOrders
📋 Description: Retrieves a list of purchase orders, enabling users to access and review order details for effective inventory and procurement management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "estimatedCost": "67.08",
10 "purchaseOrderNumber": "string",
11 "initiatedAt": "2019-08-24T14:15:22Z",
12 "initiatedBy": "string",
13 "approvedAt": "2019-08-24T14:15:22Z",
14 "approvedBy": "string",
15 "orderDate": "2019-08-24",
16 "dueDate": "2019-08-24",
17 "supplierId": 0,
18 "supplier": "string",
19 "assetPartOrders": [
20 0
21 ],
22 "purchaseOrderItems": [
23 0
24 ],
25 "purchaseOrderStatusId": 0,
26 "purchaseOrderStatus": "string",
27 "workOrderPriorityId": 0,
28 "workOrderPriority": "string",
29 "assignedUserIds": [
30 0
31 ]
32 }
33]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a purchase order, encapsulating essential details such as order items, quantities, pricing, and vendor information to facilitate efficient procurement processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» estimatedCost |
string |
false |
none |
Estimated cost of the purchase order, providing a projected financial commitment for budgeting and approval processes. |
» purchaseOrderNumber |
string |
false |
none |
Unique identifier for the purchase order, facilitating tracking and management of procurement transactions within the system. |
» initiatedAt |
string(date-time) |
false |
none |
Timestamp indicating when the purchase order was initiated, providing essential context for tracking order timelines. |
» initiatedBy |
string |
false |
none |
Identifier of the user or system that initiated the purchase order, providing context for accountability and traceability in procurement processes. |
» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the purchase order was approved, providing a record for auditing and compliance purposes. |
» approvedBy |
string |
false |
none |
Identifier of the individual or entity that has authorized the purchase order, ensuring compliance with approval processes. |
» orderDate |
string(date) |
false |
none |
Date of the order |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
» supplier |
string |
false |
none |
Name of the supplier associated with the purchase order, facilitating the identification and management of vendor relationships. |
» assetPartOrders |
[integer] |
false |
none |
An array of purchase orders associated with asset parts, facilitating the management and tracking of procurement activities within the asset lifecycle. |
» purchaseOrderItems |
[integer] |
false |
none |
An array of items included in the purchase order, detailing each product or service requested for procurement. |
» purchaseOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the purchase order status |
» purchaseOrderStatus |
string |
false |
none |
Status of the purchase order |
» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
» workOrderPriority |
string |
false |
none |
Priority of the work order |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to manage or oversee the purchase order, facilitating accountability and tracking within the procurement process. |
Create Purchase Order¶
HTTP Request
POST /api/purchaseOrders
📋 Description: Creates a new purchase order in the system, enabling efficient management of procurement processes and inventory control.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase order details, including item specifications, quantities, pricing, and vendor information necessary for processing the order. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "estimatedCost": "67.08",
9 "purchaseOrderNumber": "string",
10 "initiatedAt": "2019-08-24T14:15:22Z",
11 "initiatedBy": "string",
12 "approvedAt": "2019-08-24T14:15:22Z",
13 "approvedBy": "string",
14 "orderDate": "2019-08-24",
15 "dueDate": "2019-08-24",
16 "supplierId": 0,
17 "supplier": "string",
18 "assetPartOrders": [
19 0
20 ],
21 "purchaseOrderItems": [
22 0
23 ],
24 "purchaseOrderStatusId": 0,
25 "purchaseOrderStatus": "string",
26 "workOrderPriorityId": 0,
27 "workOrderPriority": "string",
28 "assignedUserIds": [
29 0
30 ]
31}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "estimatedCost": "67.08",
9 "purchaseOrderNumber": "string",
10 "initiatedAt": "2019-08-24T14:15:22Z",
11 "initiatedBy": "string",
12 "approvedAt": "2019-08-24T14:15:22Z",
13 "approvedBy": "string",
14 "orderDate": "2019-08-24",
15 "dueDate": "2019-08-24",
16 "supplierId": 0,
17 "supplier": "string",
18 "assetPartOrders": [
19 0
20 ],
21 "purchaseOrderItems": [
22 0
23 ],
24 "purchaseOrderStatusId": 0,
25 "purchaseOrderStatus": "string",
26 "workOrderPriorityId": 0,
27 "workOrderPriority": "string",
28 "assignedUserIds": [
29 0
30 ]
31}
Get All Documents By Purchase Order¶
HTTP Request
GET /api/purchaseOrders/{id}/documents
📋 Description: Fetches the documents associated with a specific purchase order, identified by its unique ID, to facilitate review and management of order-related documentation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Get Documents By Purchase Order ID¶
HTTP Request
GET /api/purchaseOrders/{id}/documents/{documentId}
📋 Description: Retrieves the specified document associated with a particular purchase order, enabling users to access essential documentation for review and record-keeping.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "contentType": "string",
7 "documentTypeName": "string",
8 "documentTypeId": 0,
9 "description": "string",
10 "data": "string",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "documentStatusId": 0,
14 "documentStatus": "string",
15 "documentStatusType": "string",
16 "parentEntityId": 0,
17 "link": "string",
18 "parentEntityName": "string"
19}
Get All My Purchase Orders¶
HTTP Request
GET /api/purchaseOrders/myPurchaseOrders
📋 Description: Retrieves a list of purchase orders associated with the authenticated user, providing insights into their procurement activities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "estimatedCost": "67.08",
10 "purchaseOrderNumber": "string",
11 "initiatedAt": "2019-08-24T14:15:22Z",
12 "initiatedBy": "string",
13 "approvedAt": "2019-08-24T14:15:22Z",
14 "approvedBy": "string",
15 "orderDate": "2019-08-24",
16 "dueDate": "2019-08-24",
17 "supplierId": 0,
18 "supplier": "string",
19 "assetPartOrders": [
20 0
21 ],
22 "purchaseOrderItems": [
23 0
24 ],
25 "purchaseOrderStatusId": 0,
26 "purchaseOrderStatus": "string",
27 "workOrderPriorityId": 0,
28 "workOrderPriority": "string",
29 "assignedUserIds": [
30 0
31 ]
32 }
33]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a purchase order, encapsulating essential details such as order items, quantities, pricing, and vendor information to facilitate efficient procurement processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» estimatedCost |
string |
false |
none |
Estimated cost of the purchase order, providing a projected financial commitment for budgeting and approval processes. |
» purchaseOrderNumber |
string |
false |
none |
Unique identifier for the purchase order, facilitating tracking and management of procurement transactions within the system. |
» initiatedAt |
string(date-time) |
false |
none |
Timestamp indicating when the purchase order was initiated, providing essential context for tracking order timelines. |
» initiatedBy |
string |
false |
none |
Identifier of the user or system that initiated the purchase order, providing context for accountability and traceability in procurement processes. |
» approvedAt |
string(date-time) |
false |
none |
Timestamp indicating when the purchase order was approved, providing a record for auditing and compliance purposes. |
» approvedBy |
string |
false |
none |
Identifier of the individual or entity that has authorized the purchase order, ensuring compliance with approval processes. |
» orderDate |
string(date) |
false |
none |
Date of the order |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» supplierId |
integer(int64) |
false |
none |
Unique identifier for the supplier |
» supplier |
string |
false |
none |
Name of the supplier associated with the purchase order, facilitating the identification and management of vendor relationships. |
» assetPartOrders |
[integer] |
false |
none |
An array of purchase orders associated with asset parts, facilitating the management and tracking of procurement activities within the asset lifecycle. |
» purchaseOrderItems |
[integer] |
false |
none |
An array of items included in the purchase order, detailing each product or service requested for procurement. |
» purchaseOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the purchase order status |
» purchaseOrderStatus |
string |
false |
none |
Status of the purchase order |
» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
» workOrderPriority |
string |
false |
none |
Priority of the work order |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to manage or oversee the purchase order, facilitating accountability and tracking within the procurement process. |