How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenGov Purchase Order API

The purchaseOrder API from OpenGov — 13 operation(s) for purchaseorder.

OpenGov Purchase Order API is one of 102 APIs that OpenGov publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Purchase Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 15 operations across 13 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api-purchase-order.procurement.opengov.com, https://api-purchase-order.procurement.ogstaging.us, https://api-purchase-order.procurement.ogintegration.us.

15 operations 13 paths 23 schemas 1 DELETE1 GET12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.plce.opengov.com/plce
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

OpenGov Purchase Order API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (platformApiKey). It accepts HTTP bearer tokens (platformBearerToken). By default, every request must be authenticated.

  • platformApiKey — OpenGov Platform API Key

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 1 GET, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

purchaseOrder 15
GET
/api/v1/po/entities/{entityId}/purchase-orders/{id}
Find Purchase Order by ID
purchaseOrder.findById 3 params → 200400401403404500
PUT
/api/v1/po/entities/{entityId}/purchase-orders/{id}
Update Purchase Order
purchaseOrder.update 2 params body → 200400401403404409500
DELETE
/api/v1/po/entities/{entityId}/purchase-orders/{id}
Delete a Draft Purchase Order
purchaseOrder.delete 2 params → 204400401403404500
POST
/api/v1/po/entities/{entityId}/purchase-orders
Create a Draft Purchase Order
purchaseOrder.create 1 param body → 201400401403404500
POST
/api/v1/po/entities/{entityId}/purchase-orders/search
Search Purchase Orders
purchaseOrder.search 1 param body → 200400401403404500
POST
/api/v1/po/entities/{entityId}/purchase-orders/department-po-count
Count Non-Draft Purchase Orders by Department
purchaseOrder.departmentPoCount 1 param body → 200400401403404500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/submit
Submit Purchase Order for Approval
purchaseOrder.submit 2 params body → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/approve
Approve Purchase Order
purchaseOrder.approve 2 params → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/reject
Reject Purchase Order
purchaseOrder.reject 2 params → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/issue
Issue Purchase Order
purchaseOrder.issue 2 params → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/cancel
Cancel Purchase Order
purchaseOrder.cancel 2 params → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/close
Close Purchase Order
purchaseOrder.close 2 params → 200400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/bulk
Bulk Create Approved Purchase Orders
purchaseOrder.bulkCreateApproved 1 param body → 201400401403404409500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/clear-tolerances
Clear tolerance fields on a draft purchase order
purchaseOrder.clearTolerances 2 params → 200400401403404500
POST
/api/v1/po/entities/{entityId}/purchase-orders/{id}/copy
Copy Purchase Order
purchaseOrder.copy 2 params body → 201400401403404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are LineItemModel.json (52 properties), PurchaseOrderModel.jsonUpdate (46 properties), LineItemSplitModel.json (16 properties), VendorModel.json (13 properties). Each schema is shown below with its type and property counts.

Decimal_13_5
string
LineItemSplitModel.jsonCreate
object
7 properties
SignedDecimal_18_5
string
VendorModel.json
object
13 properties 5 required
NumberFromString
string
a string to be decoded into a number
Decimal_11_5
string
ValueOrPercent
string
Indicates whether the input is an absolute value or a percentage
PoRevisionParam
string
a string to be decoded into a number
PoType
string
Purchase order type: Standard, Blanket, Emergency
UUID
string
a Universally Unique Identifier
SignedDecimal_18_2
string
PurchaseOrderModel.jsonUpdate
object
46 properties
ISODate
string
a string matching the pattern ^\d{4}-\d{2}-\d{2}$
LineItemSplitModel.json
object
16 properties 4 required
LineItemType
string
Line item type: Item, Service, Tax, Discount, Freight, Miscellaneous
PoSource
string
Purchase order source: PurchaseRequest, Contract, Manual
VendorApiCreate
object
7 properties 2 required
Decimal_18_2
string
DateTimeUtc
string
a string to be decoded into a DateTime.Utc
PoStatus
string
Purchase order status: Draft, PendingApproval, Approved, Issued, Closed, Cancelled
Decimal_18_5
string
VendorModel.jsonCreate
object
8 properties 1 required
LineItemModel.json
object
52 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opengov-purchaseorder-api-openapi.yml Raw ↑

Other APIs OpenGov publishes across the network.

OpenGov Activity API
OpenGov Activity Logs API
OpenGov Admin Settings API
OpenGov Approval Steps API
OpenGov Attachment API
OpenGov Attachment Limits API
OpenGov Attachments API
OpenGov Budget API
OpenGov Categories API
OpenGov Change Order API
OpenGov Change Order By Po API
OpenGov Chart Of Accounts API
Where this information came from

This is an independent, third-party profile of OpenGov Purchase Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.