> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/developers-api/purchase-order-management/list-purchase-orders.md).

# List Purchase Orders

Retrieves List of Purchase Orders from the database.

Retrieve purchaseorder data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.

```json
{"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Purchase Order Management","description":"Use Purchase Order Management APIs to create, import, release, close, link, and retrieve purchase orders. These endpoints support vendor purchasing, dropship workflows, incoming delivery visibility, transfer purchase orders, and sales-order-to-purchase-order linking. They are useful for procurement, supplier portals, 3PL coordination, and integrations that need to keep inbound supply synchronized with Xorosoft ERP."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/purchaseorder/getpurchaseorder":{"get":{"parameters":[{"description":"A comma-separated list of purchase order ids","in":"query","name":"id","required":false,"schema":{"type":"number"}},{"description":"A comma-separated list of purchase order numbers","in":"query","name":"order_number","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of vendor names","in":"query","name":"vendor_name","required":false,"schema":{"type":"string"}},{"description":"Restrict results to after the specified ID","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"Show purchase orders created at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"created_at_min","required":false,"schema":{"type":"string"}},{"description":"Show purchase orders updated at or after date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"updated_at_min","required":false,"schema":{"type":"string"}},{"description":"Show purchase orders created at or before date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"created_at_max","required":false,"schema":{"type":"string"}},{"description":"Show purchase orders updated at or before date (format: 2014-04-25T16:15:47-04:00)","in":"query","name":"updated_at_max","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of statuses","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"name":"store_name","in":"query","required":false,"description":"Store or warehouse name.","schema":{"type":"string"}},{"name":"third_party_ref_no","in":"query","required":false,"description":"Third-party reference number supplied by the external system.","schema":{"type":"string"}},{"name":"ref_no","in":"query","required":false,"description":"Reference number used to find matching documents or transactions.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated responses.","schema":{"type":"string","default":"1"}},{"name":"account3pl_id","in":"query","required":false,"description":"3PL account identifier.","schema":{"type":"string"}},{"name":"exclude_processed","in":"query","required":false,"description":"When true, excludes records already marked as processed.","schema":{"type":"boolean","default":false}},{"name":"vendor_id","in":"query","required":false,"description":"Vendor identifier in Xorosoft ERP.","schema":{"type":"string"}},{"name":"vendor_bill_numbers","in":"query","required":false,"description":"Comma-separated vendor bill numbers.","schema":{"type":"string"}},{"name":"vendor_po_numbers","in":"query","required":false,"description":"Comma-separated vendor purchase order numbers.","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"items":{"properties":{"poHeader":{"properties":{"AsnNumbers":{"type":"string","nullable":true},"AutoReleasePurchaseOrder":{"type":"boolean"},"BillFromAddress":{"type":"string"},"BillFromAddress2":{"type":"string"},"BillFromCity":{"type":"string"},"BillFromCompanyName":{"type":"string"},"BillFromCountry":{"type":"string"},"BillFromEmail":{"type":"string"},"BillFromFirstName":{"type":"string"},"BillFromLastName":{"type":"string"},"BillFromName":{"type":"string"},"BillFromPhoneNumber":{"type":"string"},"BillFromPostalZipCode":{"type":"string"},"BillFromState":{"type":"string"},"BuyerId":{"type":"number","nullable":true},"BuyerName":{"type":"string"},"CarrierId":{"type":"number"},"CarrierName":{"type":"string"},"CombineLines":{"type":"boolean"},"CreateDateTime":{"type":"string"},"CreateSource":{"type":"string"},"CurrencyCode":{"type":"string"},"CurrencyId":{"type":"number"},"CurrencyRate":{"type":"number"},"CurrencySymbol":{"type":"string"},"CustomFieldH1":{"type":"string"},"CustomFieldH10":{"type":"string"},"CustomFieldH11":{"type":"string"},"CustomFieldH12":{"type":"string"},"CustomFieldH13":{"type":"string"},"CustomFieldH14":{"type":"string"},"CustomFieldH15":{"type":"string"},"CustomFieldH16":{"type":"string"},"CustomFieldH17":{"type":"string"},"CustomFieldH18":{"type":"string"},"CustomFieldH19":{"type":"string"},"CustomFieldH2":{"type":"string"},"CustomFieldH20":{"type":"string"},"CustomFieldH21":{"type":"string"},"CustomFieldH22":{"type":"string"},"CustomFieldH23":{"type":"string"},"CustomFieldH24":{"type":"string"},"CustomFieldH25":{"type":"string"},"CustomFieldH26":{"type":"string"},"CustomFieldH27":{"type":"string"},"CustomFieldH28":{"type":"string"},"CustomFieldH29":{"type":"string"},"CustomFieldH3":{"type":"string"},"CustomFieldH30":{"type":"string"},"CustomFieldH4":{"type":"string"},"CustomFieldH5":{"type":"string"},"CustomFieldH6":{"type":"string"},"CustomFieldH7":{"type":"string"},"CustomFieldH8":{"type":"string"},"CustomFieldH9":{"type":"string"},"DateExpectedDelivery":{"type":"string"},"DateFulFilled":{"type":"string","nullable":true},"DateOrder":{"type":"string"},"DateReleased":{"type":"string","nullable":true},"DefaultLocationId":{"type":"number"},"DefaultLocationName":{"type":"string"},"DiscountAmount":{"type":"number"},"DropShipCustomerId":{"type":"number","nullable":true},"DropShipCustomerName":{"type":"string"},"ExpectedShipDate":{"type":"string"},"FobId":{"type":"number"},"FobName":{"type":"string","nullable":true},"FromStoreDefaultLocationName":{"type":"string","nullable":true},"Id":{"type":"number"},"IsClosed":{"type":"boolean"},"LineCount":{"type":"number"},"LinkSOToPO":{"type":"boolean"},"MainEmail":{"type":"string","nullable":true},"MainPhone":{"type":"string","nullable":true},"Memo":{"type":"string"},"ModifyDateTime":{"type":"string","nullable":true},"ModifySource":{"type":"string"},"OpenPageFromSO":{"type":"boolean"},"OrderClassCode":{"type":"string","nullable":true},"OrderClassName":{"type":"string","nullable":true},"OrderNumber":{"type":"string"},"PaymentTermsId":{"type":"number"},"PaymentTermsName":{"type":"string","nullable":true},"PoSubTypeId":{"type":"number"},"PoSubTypeName":{"type":"string"},"ProjectClassId":{"type":"number"},"ProjectClassName":{"type":"string"},"RefId":{"type":"number","nullable":true},"RefNumber":{"type":"string"},"ReportDataObj":{"properties":{"EntityAccntId":{"type":"string"},"EntityName":{"type":"string"},"ReportEntityId":{"type":"number"},"TxnRefId":{"type":"number"},"TxnRefNumber":{"type":"string"},"TxnTypeId":{"type":"number"},"linkedTxnRefId":{"type":"number","nullable":true}},"type":"object"},"ShipMethodId":{"type":"number"},"ShipMethodName":{"type":"string"},"ShipServiceId":{"type":"number"},"ShipServiceName":{"type":"string"},"ShipToAddrName":{"type":"string","nullable":true},"ShipToAddress":{"type":"string"},"ShipToAddress2":{"type":"string"},"ShipToCity":{"type":"string"},"ShipToCompanyName":{"type":"string"},"ShipToCountry":{"type":"string"},"ShipToEmail":{"type":"string"},"ShipToFirstName":{"type":"string"},"ShipToLastName":{"type":"string"},"ShipToName":{"type":"string"},"ShipToPhoneNumber":{"type":"string"},"ShipToPostalZipCode":{"type":"string"},"ShipToState":{"type":"string"},"ShippingAccountNumber":{"type":"string"},"ShippingTermsId":{"type":"number"},"ShippingTermsName":{"type":"string","nullable":true},"StatusId":{"type":"number"},"StatusName":{"type":"string"},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"SubTotal":{"type":"number"},"SubTotalExclDiscount":{"type":"number"},"Tags":{"type":"string"},"TaxSummaryDataText":{"type":"string","nullable":true},"ThirdPartyDisplayName":{"type":"string"},"ThirdPartyIconUrl":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"ToStoreDefaultLocationId":{"type":"number","nullable":true},"ToStoreDefaultLocationName":{"type":"string"},"TotalAmount":{"type":"number"},"TotalPrepayment":{"type":"number"},"TotalQty":{"type":"number"},"TransferFromStoreId":{"type":"number","nullable":true},"TransferFromStoreName":{"type":"string"},"TransferProcessedFlag":{"type":"boolean"},"TransferSoId":{"type":"number","nullable":true},"TransferSoNumber":{"type":"string"},"TransferToStoreId":{"type":"number","nullable":true},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"},"TxnTypeId":{"type":"number","nullable":true},"TypeId":{"type":"number"},"TypeName":{"type":"string"},"VendorContact":{"type":"string"},"VendorId":{"type":"number"},"VendorMsg":{"type":"string"},"VendorName":{"type":"string"},"VendorReqDate":{"type":"string"}},"type":"object"},"poLines":{"items":{"properties":{"AlternativeItemNumber1":{"type":"string"},"AlternativeItemNumber2":{"type":"string"},"AlternativeItemNumber3":{"type":"string"},"Amount":{"type":"number"},"BasePartNumber":{"type":"string"},"CancelledFlag":{"type":"boolean"},"CloseFlag":{"type":"boolean"},"CreateDateTime":{"type":"string","nullable":true},"CreateSource":{"type":"string","nullable":true},"CustomFieldD1":{"type":"string"},"CustomFieldD10":{"type":"string"},"CustomFieldD11":{"type":"string"},"CustomFieldD12":{"type":"string"},"CustomFieldD13":{"type":"string"},"CustomFieldD14":{"type":"string"},"CustomFieldD15":{"type":"string"},"CustomFieldD16":{"type":"string"},"CustomFieldD17":{"type":"string"},"CustomFieldD18":{"type":"string"},"CustomFieldD19":{"type":"string"},"CustomFieldD2":{"type":"string"},"CustomFieldD20":{"type":"string"},"CustomFieldD21":{"type":"string"},"CustomFieldD22":{"type":"string"},"CustomFieldD23":{"type":"string"},"CustomFieldD24":{"type":"string"},"CustomFieldD25":{"type":"string"},"CustomFieldD26":{"type":"string"},"CustomFieldD27":{"type":"string"},"CustomFieldD28":{"type":"string"},"CustomFieldD29":{"type":"string"},"CustomFieldD3":{"type":"string"},"CustomFieldD30":{"type":"string"},"CustomFieldD4":{"type":"string"},"CustomFieldD5":{"type":"string"},"CustomFieldD6":{"type":"string"},"CustomFieldD7":{"type":"string"},"CustomFieldD8":{"type":"string"},"CustomFieldD9":{"type":"string"},"DateExpectedDelivery":{"type":"string"},"DateLastFulFilled":{"type":"string","nullable":true},"DeleteFlag":{"type":"boolean"},"Description":{"type":"string"},"Discount":{"type":"number"},"DiscountDisp":{"type":"string"},"DiscountTypeId":{"type":"number"},"DiscountTypeName":{"type":"string","nullable":true},"EditState":{"type":"boolean"},"EffectiveUnitPrice":{"type":"number"},"ExpectedShipDate":{"type":"string"},"Id":{"type":"number"},"IsKitHeader":{"type":"boolean"},"IsKitItem":{"type":"boolean"},"IsTaxableFlag":{"type":"boolean"},"ItemBarcode":{"type":"string"},"ItemUpc":{"type":"string"},"KitItemFactor":{"type":"number"},"LineStatusId":{"type":"number"},"LineStatusName":{"type":"string"},"MasterKitId":{"type":"number","nullable":true},"MasterKitKey":{"type":"string"},"ModifyDateTime":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"Notes":{"type":"string"},"OpenFlag":{"type":"boolean"},"Option1Name":{"type":"string"},"Option1Value":{"type":"string"},"Option1ValueCode":{"type":"string"},"Option2Name":{"type":"string"},"Option2Value":{"type":"string"},"Option2ValueCode":{"type":"string"},"OrderLineClassCode":{"type":"string","nullable":true},"OrderLineClassName":{"type":"string","nullable":true},"PoId":{"type":"number"},"PoItemId":{"type":"number"},"PoItemNumber":{"type":"string"},"PoItemTypeId":{"type":"number"},"PoItemTypeName":{"type":"string"},"PoLineNumber":{"type":"number"},"ProjectClassId":{"type":"number"},"ProjectClassName":{"type":"string"},"QtyDecimalFlag":{"type":"boolean"},"QtyInReceiving":{"type":"number"},"QtyOrder":{"type":"number"},"QtyReceived":{"type":"number"},"QtyRemaining":{"type":"number"},"RefId":{"type":"number","nullable":true},"SoId":{"type":"number","nullable":true},"SoLineId":{"type":"number","nullable":true},"TaxAmount":{"type":"number"},"TaxCodeId":{"type":"number"},"TaxCodeName":{"type":"string"},"TaxData":{"type":"string","nullable":true},"TaxItems":{"type":"string","nullable":true},"Title":{"type":"string"},"TotalInReceiving":{"type":"string","nullable":true},"TxnTypeId":{"type":"number","nullable":true},"UnitPrice":{"type":"number"},"UomId":{"type":"number"},"UomName":{"type":"string"},"VendorId":{"type":"number","nullable":true},"VendorPartNumber":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Result":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Purchase Order Management"],"description":"Retrieves List of Purchase Orders from the database.\n\nRetrieve purchaseorder data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.","operationId":"get_purchaseorder_getpurchaseorder","summary":"List Purchase Orders"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xorosoft.com/developers-api/purchase-order-management/list-purchase-orders.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.