Purchase Order Statuses

The Purchase Order Statuses resource allows you to view the purchase order statuses available to your account. The response contains the fixed statuses that Unleashed provides, followed by the custom purchase order statuses that your account has configured.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List all purchase order statuses	GET `/PurchaseOrderStatuses`

An account can configure a maximum of 10 custom purchase order statuses.

GET Purchase Order Statuses

Fixed Purchase Order Statuses

The following statuses will always be returned first unless filtered out.

Status
Unapproved
Parked
Placed
Costed
Receipted
Complete
Deleted

Available Filters for GET Purchase Order Statuses

Filter	Description
`includeObsolete`	Set to `true` to also return obsolete custom statuses. Obsolete custom statuses are excluded by default.
`modifiedSince`	Only return custom statuses created or edited after a specified date, must be UTC format. The fixed statuses have no modification date, so they are not returned when this filter is used.

Available Fields for GET Purchase Order Statuses

Property	Type	Length	Notes
Name	String	15	The status name.
IsCustomStatus	Boolean		`false` for the fixed statuses, `true` for custom statuses configured in your account.
Obsolete	Boolean		Always `false` for fixed statuses.
LastModifiedOn	Nullable DateTime		Only returned for custom statuses.

Examples for Response GET `/PurchaseOrderStatuses`

show xml example

 
<?xml version="1.0"?>
<PurchaseOrderStatuses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
    <PurchaseOrderStatus>
        <Name>Unapproved</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Parked</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Placed</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Costed</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Receipted</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Complete</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Deleted</Name>
        <IsCustomStatus>false</IsCustomStatus>
        <Obsolete>false</Obsolete>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>Awaiting Stock</Name>
        <IsCustomStatus>true</IsCustomStatus>
        <Obsolete>false</Obsolete>
        <LastModifiedOn>2026-08-17T01:35:21.4783179</LastModifiedOn>
    </PurchaseOrderStatus>
    <PurchaseOrderStatus>
        <Name>In Transit</Name>
        <IsCustomStatus>true</IsCustomStatus>
        <Obsolete>false</Obsolete>
        <LastModifiedOn>2026-08-17T01:36:04.1122481</LastModifiedOn>
    </PurchaseOrderStatus>
</PurchaseOrderStatuses>

show json example

{
    "Items": [
        {
            "Name": "Unapproved",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Parked",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Placed",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Costed",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Receipted",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Complete",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Deleted",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Awaiting Stock",
            "IsCustomStatus": true,
            "Obsolete": false,
            "LastModifiedOn": "/Date(1786930521478)/"
        },
        {
            "Name": "In Transit",
            "IsCustomStatus": true,
            "Obsolete": false,
            "LastModifiedOn": "/Date(1786930564112)/"
        }
    ]
}

Purchase Order Statuses

The full range of URIs and HTTP Verbs supported are:

GET Purchase Order Statuses

Examples for Response GET /PurchaseOrderStatuses

Examples for Response GET `/PurchaseOrderStatuses`