Purchase Order Status Resource¶

Get Purchase Order Status¶

HTTP Request

GET /api/purchaseOrderStatus/{id}

📋 Description: Retrieves the status of a specific purchase order identified by the provided ID, enabling users to monitor order progress and ensure timely fulfillment.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	PurchaseOrderStatusDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true
}

Update Purchase Order Status¶

HTTP Request

PUT /api/purchaseOrderStatus/{id}

📋 Description: Updates the status of a specified purchase order, allowing businesses to efficiently manage order fulfillment and track progress in real-time.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PurchaseOrderStatusDTO	true	Request body containing updated purchase order status information, including relevant details such as status, comments, and timestamps for effective order management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Delete Purchase Order Status¶

HTTP Request

DELETE /api/purchaseOrderStatus/{id}

📋 Description: Deletes a specified purchase order status, ensuring the removal of outdated or incorrect entries from the system, thereby maintaining accurate order management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

Get All Purchase Order Statuses¶

HTTP Request

GET /api/purchaseOrderStatus

📋 Description: Retrieves the current status of purchase orders, providing insights into order fulfillment and inventory management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "isDefault": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PurchaseOrderStatusDTO]	false	none	[Data transfer object representing the status of a purchase order, including relevant metadata to facilitate tracking and management within the procurement process.]
» 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	true	none	Name of the resource
» isDefault	boolean	false	none	Whether the resource is default

Create Purchase Order Status¶

HTTP Request

POST /api/purchaseOrderStatus

📋 Description: Submits a purchase order status update, enabling businesses to track and manage their procurement processes efficiently.

Parameters

Name	In	Type	Required	Description
body	body	PurchaseOrderStatusDTO	true	Request body containing the purchase order status update data, including order ID, status, and relevant timestamps for tracking and reporting purposes.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses