> 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/create-purchase-order.md). # Create Purchase Order Creates a Purchase Order | Name | Data Type | Description | | -------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ThirdPartyRefNo` | string, required | A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created. | | `ThirdPartySource` | string | If the order came from a third party platform, it can be indicated here. | | `ThirdPartyIconUrl` | string | Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon. | | `ThirdPartyDisplayName` | string | It represents the name of third party source. | | `CheckThirdPartySource` | bool | Property, when set to true, checks if a third-party reference number exists with the same third-party source | | `StoreName` | string | It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP. | | `CurrencyCode` | string, required | It represents the currency for the order. This must match with the vendor's currency. Choose from: USD,CAD,EUR,AUD. | | `VendorName` | string, required | It represents the name of vendor. | | `DateOrder` | DateTime, required | Enter the date for the Purchase Order here. Use the MM-DD-YYYY format. | | `VendorReqDate` | DateTime, required | Enter the date for the Purchase Order here. Use the MM-DD-YYYY format. | | `DateExpectedDelivery` | DateTime, required | Enter the date the goods are expected to arrive for this PO in MM-DD-YYYY format. | | `ProjectClassName` | string | It represents the name of the Class to categorize your orders. | | `PoSubTypeName` | string | It represents the name for type of order. | | `CurrencyRate` | double, required | It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order. | | `Memo` | string | A memo for the order can be entered here. | | `PaymentTermsName` | string | It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP. | | `Tags` | string | It represents tags here for the order and multiple tags can be separated by a comma. | | `ShipMethodName` | string | It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party) | | `CarrierName` | string | If ShipMethodName is not Pick Up, then enter a carrier. | | `ShipServiceName` | string | It represents the name of ship service for the order. | | `FobName` | string | It represents the FobName for the order. | | `ShippingTermsName` | string | It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing. | | `ShippingAccountNumber` | string | It represents the shipping account number here. | | `ShipToFirstName` | string | It represents the first name of ship to for the Order. | | `ShipToLastName` | string | It represents the last name of ship to for the Order. | | `ShipToName` | string | It represents the Main address name of ship to for the Order. | | `ShipToCompanyName` | string | It represents the company name of ship to for the Order. | | `ShipToAddr` | string | It represents the address line 1 of ship to for the Order. | | `ShipToAddr2` | string | It represents the address line 2 of ship to for the Order. | | `ShipToCity` | string | It represents the city of ship to for the Order. | | `ShipToCountry` | string | It represents the country name of ship to for the Order. | | `ShipToState` | string | It represents the state name of ship to for the Order. | | `ShipToPostalZipCode` | string | It represents the zip code of ship to for the Order. | | `ShipToPhoneNumber` | string | It represents the phone number of ship to for the Order. | | `ShipToEmail` | string | It represents the email of ship to for the Order. | | `BuyerName` | string | It is a name of Buyer. | | `BillFromFirstName` | string | It represents the first name of bill from for the Order. | | `BillFromLastName` | string | It represents the last name of bill from for the Order. | | `BillFromName` | string | It represents the Main address name of bill from for the Order. | | `BillFromAddress` | string | It represents the address line 1 of bill from for the Order. | | `BillFromAddress2` | string | It represents the address line 2 of bill from for the Order. | | `BillFromCity` | string | It represents the city of bill from for the Order. | | `BillFromCountry` | string | It represents the country name of bill from for the Order. | | `BillFromState` | string | It represents the state name of bill from for the Order. | | `BillFromPostalZipCode` | string | It represents the zip code of bill from for the Order. | | `BillFromCompanyName` | string | It represents the company name of bill from for the Order. | | `BillFromPhoneNumber` | string | It represents the phone number of bill from for the Order. | | `BillFromEmail` | string | It represents the email of bill from for the Order. | | `PaymentTermsName` | string | Enter a Payment Term from Xorosoft ERP for the PO here.Common terms include:Net 30,Credit Card. | | `CustomFieldH1` | string | Custom Fields (CustomFieldH1 - CustomFieldH30). | | `ItemNumber` | string, required | The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number. | | `Description` | string | The item's description. | | `UnitPrice` | double, required | The item's Unit Price. | | `QtyOrder` | double, required | The item's Qty. | | `Discount` | double | The item's Discount. | | `DiscountTypeName` | string | Percentage or Amount. | | `AutoReleasePurchaseOrder` | bool | This will auto release the purchase order while creating purchase order. | | `CustomFieldD1` | string | Custom Fields (CustomFieldD1 - CustomFieldD30). | #### Equivalent Routes This operation is documented once to avoid duplicate pages. The same workflow is also available at: `/api/xerp/purchaseorder/import`. ```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/create":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"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","nullable":true},"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","nullable":true},"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","nullable":true},"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","nullable":true},"ShipMethodName":{"type":"string"},"ShipServiceId":{"type":"number","nullable":true},"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","nullable":true},"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","nullable":true},"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","nullable":true},"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"}},"required":["AlternativeItemNumber1","AlternativeItemNumber2","AlternativeItemNumber3","Amount","BasePartNumber","CancelledFlag","CloseFlag","CreateDateTime","CreateSource","CustomFieldD1","CustomFieldD10","CustomFieldD11","CustomFieldD12","CustomFieldD13","CustomFieldD14","CustomFieldD15","CustomFieldD16","CustomFieldD17","CustomFieldD18","CustomFieldD19","CustomFieldD2","CustomFieldD20","CustomFieldD21","CustomFieldD22","CustomFieldD23","CustomFieldD24","CustomFieldD25","CustomFieldD26","CustomFieldD27","CustomFieldD28","CustomFieldD29","CustomFieldD3","CustomFieldD30","CustomFieldD4","CustomFieldD5","CustomFieldD6","CustomFieldD7","CustomFieldD8","CustomFieldD9","DateExpectedDelivery","DateLastFulFilled","DeleteFlag","Description","Discount","DiscountDisp","DiscountTypeId","DiscountTypeName","EditState","EffectiveUnitPrice","ExpectedShipDate","Id","IsKitHeader","IsKitItem","IsTaxableFlag","ItemBarcode","ItemUpc","KitItemFactor","LineStatusId","LineStatusName","MasterKitId","MasterKitKey","ModifyDateTime","ModifySource","Notes","OpenFlag","Option1Name","Option1Value","Option1ValueCode","Option2Name","Option2Value","Option2ValueCode","OrderLineClassCode","OrderLineClassName","PoId","PoItemId","PoItemNumber","PoItemTypeId","PoItemTypeName","PoLineNumber","ProjectClassId","ProjectClassName","QtyDecimalFlag","QtyInReceiving","QtyOrder","QtyReceived","QtyRemaining","RefId","SoId","SoLineId","TaxAmount","TaxCodeId","TaxCodeName","TaxData","TaxItems","Title","TotalInReceiving","TxnTypeId","UnitPrice","UomId","UomName","VendorId","VendorPartNumber"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Purchase Order Management"],"description":"Creates a Purchase Order\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``ThirdPartyRefNo``|string, required|A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created.\n``ThirdPartySource``|string|If the order came from a third party platform, it can be indicated here.\n``ThirdPartyIconUrl``|string|Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon.\n``ThirdPartyDisplayName``|string|It represents the name of third party source.\n``CheckThirdPartySource``|bool|Property, when set to true, checks if a third-party reference number exists with the same third-party source\n``StoreName``|string|It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP.\n``CurrencyCode``|string, required|It represents the currency for the order. This must match with the vendor's currency. Choose from: USD,CAD,EUR,AUD.\n``VendorName``|string, required|It represents the name of vendor.\n``DateOrder``|DateTime, required|Enter the date for the Purchase Order here. Use the MM-DD-YYYY format.\n``VendorReqDate``|DateTime, required|Enter the date for the Purchase Order here. Use the MM-DD-YYYY format.\n``DateExpectedDelivery``|DateTime, required|Enter the date the goods are expected to arrive for this PO in MM-DD-YYYY format. \n``ProjectClassName``|string|It represents the name of the Class to categorize your orders.\n``PoSubTypeName``|string|It represents the name for type of order.\n``CurrencyRate``|double, required|It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order.\n``Memo``|string|A memo for the order can be entered here.\n``PaymentTermsName``|string|It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP.\n``Tags``|string|It represents tags here for the order and multiple tags can be separated by a comma.\n``ShipMethodName``|string|It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party)\n``CarrierName``|string|If ShipMethodName is not Pick Up, then enter a carrier.\n``ShipServiceName``|string|It represents the name of ship service for the order.\n``FobName``|string|It represents the FobName for the order.\n``ShippingTermsName``|string|It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing.\n``ShippingAccountNumber``|string|It represents the shipping account number here.\n``ShipToFirstName``|string|It represents the first name of ship to for the Order.\n``ShipToLastName``|string|It represents the last name of ship to for the Order.\n``ShipToName``|string|It represents the Main address name of ship to for the Order.\n``ShipToCompanyName``|string|It represents the company name of ship to for the Order.\n``ShipToAddr``|string|It represents the address line 1 of ship to for the Order.\n``ShipToAddr2``|string|It represents the address line 2 of ship to for the Order.\n``ShipToCity``|string|It represents the city of ship to for the Order.\n``ShipToCountry``|string|It represents the country name of ship to for the Order.\n``ShipToState``|string|It represents the state name of ship to for the Order.\n``ShipToPostalZipCode``|string|It represents the zip code of ship to for the Order.\n``ShipToPhoneNumber``|string|It represents the phone number of ship to for the Order.\n``ShipToEmail``|string|It represents the email of ship to for the Order.\n``BuyerName``|string|It is a name of Buyer.\n``BillFromFirstName``|string|It represents the first name of bill from for the Order.\n``BillFromLastName``|string|It represents the last name of bill from for the Order.\n``BillFromName``|string|It represents the Main address name of bill from for the Order.\n``BillFromAddress``|string|It represents the address line 1 of bill from for the Order.\n``BillFromAddress2``|string|It represents the address line 2 of bill from for the Order.\n``BillFromCity``|string|It represents the city of bill from for the Order.\n``BillFromCountry``|string|It represents the country name of bill from for the Order.\n``BillFromState``|string|It represents the state name of bill from for the Order.\n``BillFromPostalZipCode``|string|It represents the zip code of bill from for the Order.\n``BillFromCompanyName``|string|It represents the company name of bill from for the Order.\n``BillFromPhoneNumber``|string|It represents the phone number of bill from for the Order.\n``BillFromEmail``|string|It represents the email of bill from for the Order.\n``PaymentTermsName``|string|Enter a Payment Term from Xorosoft ERP for the PO here.Common terms include:Net 30,Credit Card.\n``CustomFieldH1``|string|Custom Fields (CustomFieldH1 - CustomFieldH30).\n``ItemNumber``|string, required|The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number.\n``Description``|string|The item's description.\n``UnitPrice``|double, required|The item's Unit Price.\n``QtyOrder``|double, required|The item's Qty.\n``Discount``|double|The item's Discount.\n``DiscountTypeName``|string|Percentage or Amount.\n``AutoReleasePurchaseOrder``|bool|This will auto release the purchase order while creating purchase order. \n``CustomFieldD1``|string|Custom Fields (CustomFieldD1 - CustomFieldD30).\n\n### Equivalent Routes\n\nThis operation is documented once to avoid duplicate pages. The same workflow is also available at: `/api/xerp/purchaseorder/import`.","operationId":"post_purchaseorder_create","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Additional Purchase Order fields accepted by the current Xorosoft ERP Purchase Order controller. Most fields are optional. Provide server-managed identifiers and calculated values only when updating an existing order or when the integration workflow requires them.","properties":{"poHeader":{"type":"object","description":"Additional purchase order header fields. These combine with the core poHeader fields documented on the create operation.","properties":{"Account3PLCode":{"type":"string"},"Account3PLId":{"type":"integer"},"AddressVerificationIdentifierCode":{"type":"integer","nullable":true},"ApplyPricingRule":{"type":"boolean"},"ApproverName":{"type":"string"},"AsnNotes":{"type":"string"},"AsnNumbers":{"type":"string"},"AutoGenerateAsn":{"type":"boolean","description":"When true, automatically creates an ASN for the purchase order."},"BillFromAddrHashCode":{"type":"integer"},"BrandId":{"type":"integer","nullable":true},"BrandName":{"type":"string"},"BuyerId":{"type":"integer","nullable":true},"CancelReasonCode":{"type":"string"},"CancelReasonName":{"type":"string"},"CarrierCode":{"type":"string"},"CarrierId":{"type":"integer","nullable":true},"CombineLines":{"type":"boolean","description":"When true, combines compatible purchase order lines during processing."},"CreateDateTime":{"type":"string","format":"date-time","nullable":true},"CreateDttm":{"type":"string","format":"date-time","nullable":true},"CreateSource":{"type":"string"},"CurrencyId":{"type":"integer"},"CurrencySymbol":{"type":"string"},"CustomFieldH31":{"type":"string"},"CustomFieldH32":{"type":"string"},"CustomFieldH33":{"type":"string"},"CustomFieldH34":{"type":"string"},"CustomFieldH35":{"type":"string"},"CustomFieldH36":{"type":"string"},"CustomFieldH37":{"type":"string"},"CustomFieldH38":{"type":"string"},"CustomFieldH39":{"type":"string"},"CustomFieldH40":{"type":"string"},"CustomFieldH41":{"type":"string"},"CustomFieldH42":{"type":"string"},"CustomFieldH43":{"type":"string"},"CustomFieldH44":{"type":"string"},"CustomFieldH45":{"type":"string"},"CustomFieldH46":{"type":"string"},"CustomFieldH47":{"type":"string"},"CustomFieldH48":{"type":"string"},"CustomFieldH49":{"type":"string"},"CustomFieldH50":{"type":"string"},"CustomFieldsToUpdate":{"type":"object","additionalProperties":true},"Customer3PLMainEmail":{"type":"string"},"DateFulFilled":{"type":"string","format":"date-time","nullable":true},"DateReleased":{"type":"string","format":"date-time","nullable":true},"DefaultLocationId":{"type":"integer","nullable":true},"DeletedOrderLinkingArr":{"type":"array","items":{"type":"object","additionalProperties":true}},"DropShipCustomerId":{"type":"integer","nullable":true},"DropShipCustomerName":{"type":"string"},"DropshipFreightAmount":{"type":"number","nullable":true},"EntityUseCode":{"type":"string"},"ExpectedShipDate":{"type":"string","format":"date-time","nullable":true},"FobId":{"type":"integer","nullable":true},"FromStoreDefaultLocationName":{"type":"string"},"HashCodeJson":{"type":"string"},"Id":{"type":"integer","format":"int64"},"InCompleteTaskCount":{"type":"integer","nullable":true},"InvalidAddressFlag":{"type":"boolean"},"IsAccount3plApiRequest":{"type":"boolean"},"IsApprovalRequiredFlag":{"type":"boolean"},"IsApproved":{"type":"boolean"},"IsClosed":{"type":"boolean"},"IsDropShip":{"type":"boolean"},"IsExistingPOLine":{"type":"boolean"},"IsProcessed":{"type":"boolean"},"ItemQualityCode":{"type":"string"},"KeepOriginalOrderNumber":{"type":"boolean"},"LastApprovedAmount":{"type":"number"},"LastApprovedDateTime":{"type":"string","format":"date-time","nullable":true},"LastApprovedSource":{"type":"string"},"LineCount":{"type":"integer"},"LinkSOToPO":{"type":"boolean","description":"When true, creates or preserves the sales-order-to-purchase-order linkage."},"LinkedSO":{"type":"string"},"MainEmail":{"type":"string"},"MainPhone":{"type":"string"},"MetaData":{"type":"string"},"MoNumbers":{"type":"string"},"ModifyDateTime":{"type":"string","format":"date-time","nullable":true},"ModifyDttm":{"type":"string","format":"date-time","nullable":true},"ModifySource":{"type":"string"},"OpenPageFromSO":{"type":"boolean"},"OrderClassCode":{"type":"string"},"OrderClassName":{"type":"string"},"OrderNumber":{"type":"string"},"OrderTypeCode":{"type":"string"},"OrderTypeName":{"type":"string"},"POApprovalStatus":{"type":"string"},"PaymentTermsId":{"type":"integer","nullable":true},"PoSubTypeId":{"type":"integer","nullable":true},"PreserveOrderLinking":{"type":"boolean","description":"Preserves existing sales-order-to-purchase-order links when the order is updated."},"ProcessedDttm":{"type":"string","format":"date-time","nullable":true},"ProcessedSource":{"type":"string"},"ProjectClassId":{"type":"integer","nullable":true},"QualityId":{"type":"integer","nullable":true},"ReceivingStatusId":{"type":"integer"},"ReceivingStatusName":{"type":"string"},"RefId":{"type":"string"},"RefNumber":{"type":"string"},"ReportDataObj":{"type":"object","additionalProperties":true},"ShipFromAddress":{"type":"string"},"ShipFromAddress2":{"type":"string"},"ShipFromCity":{"type":"string"},"ShipFromCountry":{"type":"string"},"ShipFromPostalZipCode":{"type":"string"},"ShipFromState":{"type":"string"},"ShipMethodId":{"type":"integer","nullable":true},"ShipServiceCode":{"type":"string"},"ShipServiceId":{"type":"integer","nullable":true},"ShipToAddrHashCode":{"type":"integer"},"ShippingAccountNumber":{"type":"string"},"ShippingTermsId":{"type":"integer","nullable":true},"ShippingTermsName":{"type":"string"},"StatusId":{"type":"integer"},"StatusName":{"type":"string"},"StoreId":{"type":"integer"},"SubTotal":{"type":"number"},"SubTotalExclDiscount":{"type":"number"},"TaxServiceHashCode":{"type":"integer"},"TaxServiceHashCodeOld":{"type":"integer"},"TaxSummaryDataText":{"type":"string"},"ThirdPartyOrderAlreadyExists":{"type":"boolean"},"ToStoreDefaultLocationId":{"type":"integer","nullable":true},"ToStoreDefaultLocationName":{"type":"string"},"TotalCBM":{"type":"number","nullable":true},"TotalEstimatedDutyAmount":{"type":"number","nullable":true},"TotalPrepayment":{"type":"number"},"TotalQty":{"type":"number"},"TotalTaskCount":{"type":"integer","nullable":true},"TransferFromStoreId":{"type":"integer","nullable":true},"TransferFromStoreName":{"type":"string"},"TransferProcessedFlag":{"type":"boolean"},"TransferSoId":{"type":"integer","nullable":true},"TransferSoNumber":{"type":"string"},"TransferToStoreId":{"type":"integer","nullable":true},"TriggerIncomingPoDeliveryWebhookFlag":{"type":"boolean"},"TxnId":{"type":"string"},"TxnNumber":{"type":"integer","format":"int64"},"TxnTypeId":{"type":"string"},"TypeId":{"type":"integer"},"TypeName":{"type":"string"},"UpdateEnable":{"type":"boolean","description":"Enables matching and updating an existing order by third-party reference number or order number."},"UpdateFromSo":{"type":"boolean"},"UpdatedOrderLinkingArr":{"type":"array","items":{"type":"object","additionalProperties":true}},"Vendor3PLTypeId":{"type":"integer"},"Vendor3PLTypeName":{"type":"string"},"VendorAccountNumber":{"type":"string"},"VendorContact":{"type":"string"},"VendorEmailCC":{"type":"string"},"VendorEmailMain":{"type":"string"},"VendorId":{"type":"integer","nullable":true},"VendorMsg":{"type":"string"},"VendorPartNumber":{"type":"string"},"VoidAndCreate":{"type":"boolean","description":"When updating an existing purchase order, voids the prior order and creates a replacement."},"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"},"BuyerName":{"type":"string","nullable":true},"CarrierName":{"type":"string"},"CheckThirdPartySource":{"type":"boolean"},"CurrencyCode":{"type":"string"},"CurrencyRate":{"type":"number"},"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"},"DateOrder":{"type":"string"},"DefaultLocationName":{"type":"string"},"DiscountAmount":{"type":"number"},"FobName":{"type":"string"},"Memo":{"type":"string"},"PaymentTermsName":{"type":"string"},"PoSubTypeName":{"type":"string"},"ProjectClassName":{"type":"string"},"ShipMethodName":{"type":"string"},"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"},"StoreName":{"type":"string"},"Tags":{"type":"string"},"ThirdPartyDisplayName":{"type":"string"},"ThirdPartyIconUrl":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"TotalAmount":{"type":"number"},"VendorName":{"type":"string"},"VendorReqDate":{"type":"string"}}},"poLines":{"type":"array","description":"Additional purchase order line fields. These combine with the core poLines fields documented on the create operation.","items":{"type":"object","properties":{"Account3plId":{"type":"integer","nullable":true},"AllowedPurchaseUOMList":{"type":"array","items":{"type":"object","additionalProperties":true}},"AlternativeItemNumber1":{"type":"string"},"AlternativeItemNumber2":{"type":"string"},"AlternativeItemNumber3":{"type":"string"},"Amount":{"type":"number","nullable":true},"AutoCreateItemFlag":{"type":"boolean"},"BasePartNumber":{"type":"string"},"BaseQtyOrdered":{"type":"number","nullable":true},"BaseQtyRemainingToShip":{"type":"number","nullable":true},"BaseQtyShipped":{"type":"number","nullable":true},"BaseUomId":{"type":"integer","nullable":true},"BaseUomName":{"type":"string"},"BrandName":{"type":"string"},"CancelledFlag":{"type":"boolean"},"CloseFlag":{"type":"boolean"},"CopiedFromShortQtyFlag":{"type":"boolean"},"CreateDateTime":{"type":"string"},"CreateSource":{"type":"string"},"CustomFieldD31":{"type":"string"},"CustomFieldD32":{"type":"string"},"CustomFieldD33":{"type":"string"},"CustomFieldD34":{"type":"string"},"CustomFieldD35":{"type":"string"},"CustomFieldD36":{"type":"string"},"CustomFieldD37":{"type":"string"},"CustomFieldD38":{"type":"string"},"CustomFieldD39":{"type":"string"},"CustomFieldD40":{"type":"string"},"CustomFieldD41":{"type":"string"},"CustomFieldD42":{"type":"string"},"CustomFieldD43":{"type":"string"},"CustomFieldD44":{"type":"string"},"CustomFieldD45":{"type":"string"},"CustomFieldD46":{"type":"string"},"CustomFieldD47":{"type":"string"},"CustomFieldD48":{"type":"string"},"CustomFieldD49":{"type":"string"},"CustomFieldD50":{"type":"string"},"DateExpectedDelivery":{"type":"string","format":"date-time","nullable":true},"DateLastFulFilled":{"type":"string","format":"date-time","nullable":true},"DefaultPurchaseUomId":{"type":"integer","format":"int64"},"DeleteFlag":{"type":"boolean","description":"Marks an existing purchase order line for deletion during an update."},"DiscountDisp":{"type":"string"},"DiscountTypeId":{"type":"integer","nullable":true},"DropshipSoId":{"type":"integer","format":"int64","nullable":true},"DropshipSoLineId":{"type":"integer","format":"int64","nullable":true},"DropshipSoNumber":{"type":"string"},"EditState":{"type":"boolean"},"EffectiveUnitPrice":{"type":"number","nullable":true},"EstimatedDutyAmount":{"type":"number","nullable":true},"EstimatedDutyPercentage":{"type":"number","nullable":true},"ExpectedShipDate":{"type":"string","format":"date-time","nullable":true},"HSCode":{"type":"string"},"Id":{"type":"integer","format":"int64"},"ImagePath":{"type":"string"},"IsBomItemFlag":{"type":"boolean","nullable":true},"IsCopiedFromSO":{"type":"boolean"},"IsKitHeader":{"type":"boolean"},"IsKitItem":{"type":"boolean"},"IsMergedChildLine":{"type":"boolean"},"IsMergedParentLine":{"type":"boolean"},"IsPriceChanged":{"type":"boolean"},"IsProducibleFlag":{"type":"boolean","nullable":true},"IsTaxableFlag":{"type":"boolean"},"ItemBarcode":{"type":"string"},"ItemCategoryName":{"type":"string"},"ItemGroupName":{"type":"string"},"ItemIdentifierCode":{"type":"integer","nullable":true},"ItemQualityCode":{"type":"string"},"ItemSubCategoryName":{"type":"string"},"ItemUpc":{"type":"string"},"ItemWeight":{"type":"number","nullable":true},"ItemWeightUomId":{"type":"integer","nullable":true},"ItemWeightUomName":{"type":"string"},"KitItemFactor":{"type":"number","nullable":true},"LineStatusId":{"type":"integer","nullable":true},"LineStatusName":{"type":"string"},"LinkedQty":{"type":"number","nullable":true},"LinkedSoNumbers":{"type":"string"},"Manufacturer":{"type":"string"},"MasterKitId":{"type":"integer","nullable":true},"MasterKitKey":{"type":"string"},"MaterialName":{"type":"string"},"ModifyDateTime":{"type":"string"},"ModifySource":{"type":"string"},"OpenFlag":{"type":"boolean"},"Option1Name":{"type":"string"},"Option1Seq":{"type":"integer","nullable":true},"Option1Value":{"type":"string"},"Option1ValueCode":{"type":"string"},"Option2Name":{"type":"string"},"Option2Seq":{"type":"integer","nullable":true},"Option2Value":{"type":"string"},"Option2ValueCode":{"type":"string"},"Option3Name":{"type":"string"},"Option3Seq":{"type":"integer","nullable":true},"Option3Value":{"type":"string"},"Option3ValueCode":{"type":"string"},"OrderLineClassCode":{"type":"string"},"OrderLineClassName":{"type":"string"},"OrderNumber":{"type":"string"},"PoId":{"type":"integer","format":"int64"},"PoItemId":{"type":"integer","format":"int64","nullable":true},"PoItemTypeId":{"type":"integer","nullable":true},"PoLineNumber":{"type":"integer"},"ProductCategoryName":{"type":"string"},"ProductHeaderId":{"type":"integer","format":"int64","nullable":true},"ProjectClassId":{"type":"integer","nullable":true},"ProjectClassName":{"type":"string"},"PtoId":{"type":"integer","format":"int64","nullable":true},"PurchaseNotes":{"type":"string"},"PurchaseRatePerWeightUnit":{"type":"number","nullable":true},"QtyAvailableToReceive":{"type":"number","nullable":true},"QtyDecimalFlag":{"type":"boolean"},"QtyInReceiving":{"type":"number","nullable":true},"QtyOpenAsn":{"type":"number","nullable":true},"QtyReceived":{"type":"number","nullable":true},"QtyReceivedPercentage":{"type":"number","nullable":true},"QtyRemaining":{"type":"number","nullable":true},"QtyToReceive":{"type":"number","nullable":true},"QualityId":{"type":"integer","nullable":true},"ReceivedQuality":{"type":"string"},"RefId":{"type":"string"},"Season":{"type":"string"},"SoId":{"type":"integer","format":"int64","nullable":true},"SoLineId":{"type":"integer","format":"int64","nullable":true},"SoLineQty":{"type":"number","nullable":true},"StandardUnitPrice":{"type":"number","nullable":true},"TaxCategoryCode":{"type":"string"},"TaxCodeId":{"type":"integer","nullable":true},"TaxData":{"type":"object","additionalProperties":true},"TaxItems":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"integer"},"Name":{"type":"string"},"TotalAmount":{"type":"number"},"Rate":{"type":"number"},"RateType":{"type":"string"},"IsShippingTax":{"type":"boolean"}}}},"ThirdPartyRefNo":{"type":"string"},"Title":{"type":"string"},"TotalInReceiving":{"type":"number","nullable":true},"TransferSoLineId":{"type":"integer","format":"int64","nullable":true},"TxnTypeId":{"type":"string"},"UnitCBM":{"type":"number","nullable":true},"UomFactor":{"type":"number","nullable":true},"UomId":{"type":"integer","nullable":true},"UomName":{"type":"string"},"VendorId":{"type":"integer","nullable":true},"VendorInternalNotes":{"type":"string"},"VendorPartDescription":{"type":"string"},"VendorPartNumber":{"type":"string"},"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"},"Description":{"type":"string"},"Discount":{"type":"number"},"DiscountTypeName":{"type":"string"},"Notes":{"type":"string"},"PoItemNumber":{"type":"string"},"PoItemTypeName":{"type":"string"},"QtyOrder":{"type":"number"},"TaxAmount":{"type":"number"},"TaxCodeName":{"type":"string"},"UnitPrice":{"type":"number"}}}},"uccCartonArr":{"type":"array","description":"Optional carton and UCC data associated with purchase order lines.","items":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"AsnId":{"type":"integer","format":"int64"},"AsnLineId":{"type":"integer","format":"int64"},"LineIdentifier":{"type":"integer"},"UCC":{"type":"string"},"PalletUCC":{"type":"string"},"Qty":{"type":"number"},"AsnNumber":{"type":"string"},"TotalQtyToReceive":{"type":"number"},"TotalQtyReceived":{"type":"number"},"ItemId":{"type":"integer","format":"int64"},"ItemNumber":{"type":"string"},"ItemUpc":{"type":"string"},"ItemDescription":{"type":"string"},"AlternativeItemNumber1":{"type":"string"},"AlternativeItemNumber2":{"type":"string"},"AlternativeItemNumber3":{"type":"string"},"AsnLineStatusId":{"type":"integer"},"ExpectedQualityId":{"type":"integer","format":"int64"},"StoreId":{"type":"integer"},"LpnNumber":{"type":"string"},"QtyOnAsn":{"type":"number"},"BatchNumber":{"type":"string"},"LotNumber":{"type":"string"},"QualityId":{"type":"integer","format":"int64"},"MfgDate":{"type":"string","format":"date-time","nullable":true},"ExpDate":{"type":"string","format":"date-time","nullable":true},"Pallet":{"type":"string"},"LocId":{"type":"integer","format":"int64"},"DispLoc":{"type":"string"},"Account3plId":{"type":"integer","nullable":true},"PoId":{"type":"integer","format":"int64","nullable":true},"ItemObj":{"type":"object","additionalProperties":true},"PoNumber":{"type":"string"},"RmaNumber":{"type":"string"}}}}}}}}},"summary":"Create Purchase Order"}}}} ``` --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xorosoft.com/developers-api/purchase-order-management/create-purchase-order.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.