Create Purchase Order
Creates a Purchase Order
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.
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.
OK
POST /api/xerp/purchaseorder/create HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 2731
{
"poHeader": {
"AutoReleasePurchaseOrder": false,
"BillFromAddress": "3801 E Frank Phillips Blvd",
"BillFromAddress2": "",
"BillFromCity": "Bartlesville",
"BillFromCompanyName": "Test Vendor",
"BillFromCountry": "US",
"BillFromEmail": "",
"BillFromFirstName": "",
"BillFromLastName": "",
"BillFromName": "",
"BillFromPhoneNumber": "",
"BillFromPostalZipCode": "74006",
"BillFromState": "OK",
"BuyerName": null,
"CarrierName": "FedEx",
"CheckThirdPartySource": false,
"CurrencyCode": "USD",
"CurrencyRate": 1,
"CustomFieldH1": "",
"CustomFieldH10": "",
"CustomFieldH11": "",
"CustomFieldH12": "",
"CustomFieldH13": "",
"CustomFieldH14": "",
"CustomFieldH15": "",
"CustomFieldH16": "",
"CustomFieldH17": "",
"CustomFieldH18": "",
"CustomFieldH19": "",
"CustomFieldH2": "",
"CustomFieldH20": "",
"CustomFieldH21": "",
"CustomFieldH22": "",
"CustomFieldH23": "",
"CustomFieldH24": "",
"CustomFieldH25": "",
"CustomFieldH26": "",
"CustomFieldH27": "",
"CustomFieldH28": "",
"CustomFieldH29": "",
"CustomFieldH3": "",
"CustomFieldH30": "",
"CustomFieldH4": "",
"CustomFieldH5": "",
"CustomFieldH6": "",
"CustomFieldH7": "",
"CustomFieldH8": "",
"CustomFieldH9": "",
"DateExpectedDelivery": "03/26/2021",
"DateOrder": "03/26/2021",
"DefaultLocationName": "MAIN WAREHOUSE - LOCATION-3PL",
"DiscountAmount": 5,
"FobName": "Origin",
"Memo": "Test Memo",
"PaymentTermsName": "NET 30",
"PoSubTypeName": "Appliances",
"ProjectClassName": "Online",
"ShipMethodName": "Delivery (Third Party)",
"ShipServiceName": "FedEx 1Day(R) Freight",
"ShipToAddrName": null,
"ShipToAddress": "130 S LA BREA AVE",
"ShipToAddress2": "",
"ShipToCity": "Los Angeles",
"ShipToCompanyName": "",
"ShipToCountry": "US",
"ShipToEmail": "",
"ShipToFirstName": "",
"ShipToLastName": "",
"ShipToName": "",
"ShipToPhoneNumber": "",
"ShipToPostalZipCode": "90036",
"ShipToState": "CA",
"StoreName": "Main Warehouse",
"Tags": "",
"ThirdPartyDisplayName": "",
"ThirdPartyIconUrl": "",
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"TotalAmount": 965.25,
"VendorName": "Test Vendor",
"VendorReqDate": "03/26/2021"
},
"poLines": [
{
"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": "",
"Description": "1234",
"Discount": 10,
"DiscountTypeName": "Percentage",
"Notes": "Test Notes",
"PoItemNumber": "123",
"PoItemTypeName": "Inventory",
"QtyOrder": 1,
"TaxAmount": 65.25,
"TaxCodeName": "ALPINE CO. 7.25%",
"UnitPrice": 120
}
]
}OK
{
"poHeader": {
"AsnNumbers": null,
"AutoReleasePurchaseOrder": false,
"BillFromAddress": "3801 E Frank Phillips Blvd",
"BillFromAddress2": "",
"BillFromCity": "Bartlesville",
"BillFromCompanyName": "Test Vendor",
"BillFromCountry": "US",
"BillFromEmail": "",
"BillFromFirstName": "",
"BillFromLastName": "",
"BillFromName": "",
"BillFromPhoneNumber": "",
"BillFromPostalZipCode": "74006",
"BillFromState": "OK",
"BuyerId": null,
"BuyerName": "",
"CarrierId": null,
"CarrierName": "",
"CombineLines": false,
"CreateDateTime": "03/27/2021 03:33:18 AM",
"CreateSource": "API Testing (API)",
"CurrencyCode": "USD",
"CurrencyId": 1001,
"CurrencyRate": 1,
"CurrencySymbol": "$ ",
"CustomFieldH1": "",
"CustomFieldH10": "",
"CustomFieldH11": "",
"CustomFieldH12": "",
"CustomFieldH13": "",
"CustomFieldH14": "",
"CustomFieldH15": "",
"CustomFieldH16": "",
"CustomFieldH17": "",
"CustomFieldH18": "",
"CustomFieldH19": "",
"CustomFieldH2": "",
"CustomFieldH20": "",
"CustomFieldH21": "",
"CustomFieldH22": "",
"CustomFieldH23": "",
"CustomFieldH24": "",
"CustomFieldH25": "",
"CustomFieldH26": "",
"CustomFieldH27": "",
"CustomFieldH28": "",
"CustomFieldH29": "",
"CustomFieldH3": "",
"CustomFieldH30": "",
"CustomFieldH4": "",
"CustomFieldH5": "",
"CustomFieldH6": "",
"CustomFieldH7": "",
"CustomFieldH8": "",
"CustomFieldH9": "",
"DateExpectedDelivery": "03/26/2021",
"DateFulFilled": null,
"DateOrder": "03/26/2021",
"DateReleased": null,
"DefaultLocationId": 1,
"DefaultLocationName": "MAIN WAREHOUSE - LOCATION-3PL",
"DiscountAmount": 0,
"DropShipCustomerId": null,
"DropShipCustomerName": "",
"ExpectedShipDate": null,
"FobId": 10,
"FobName": null,
"FromStoreDefaultLocationName": null,
"Id": 22489,
"IsClosed": false,
"LineCount": 0,
"LinkSOToPO": false,
"MainEmail": null,
"MainPhone": null,
"Memo": "Test Memo",
"ModifyDateTime": null,
"ModifySource": "",
"OpenPageFromSO": false,
"OrderClassCode": null,
"OrderClassName": null,
"OrderNumber": "MAIN-P002354",
"PaymentTermsId": 35,
"PaymentTermsName": null,
"PoSubTypeId": null,
"PoSubTypeName": "",
"ProjectClassId": 0,
"ProjectClassName": "",
"RefId": null,
"RefNumber": "",
"ReportDataObj": {
"EntityAccntId": "372642B0-E5BB-4B25-8A1D-DE313839D850",
"EntityName": "Test Vendor",
"ReportEntityId": 105,
"TxnRefId": 22489,
"TxnRefNumber": "MAIN-P002354",
"TxnTypeId": 114,
"linkedTxnRefId": null
},
"ShipMethodId": null,
"ShipMethodName": "",
"ShipServiceId": null,
"ShipServiceName": "",
"ShipToAddrName": null,
"ShipToAddress": "130 S LA BREA AVE",
"ShipToAddress2": "",
"ShipToCity": "Los Angeles",
"ShipToCompanyName": "",
"ShipToCountry": "US",
"ShipToEmail": "",
"ShipToFirstName": "",
"ShipToLastName": "",
"ShipToName": "",
"ShipToPhoneNumber": "",
"ShipToPostalZipCode": "90036",
"ShipToState": "CA",
"ShippingAccountNumber": "",
"ShippingTermsId": null,
"ShippingTermsName": null,
"StatusId": 10,
"StatusName": "Open",
"StoreId": 10002,
"StoreName": "Main Warehouse",
"SubTotal": 0,
"SubTotalExclDiscount": 0,
"Tags": "",
"TaxSummaryDataText": null,
"ThirdPartyDisplayName": "",
"ThirdPartyIconUrl": "",
"ThirdPartyRefNo": "",
"ThirdPartySource": "",
"ToStoreDefaultLocationId": null,
"ToStoreDefaultLocationName": "",
"TotalAmount": 173.25,
"TotalPrepayment": 0,
"TotalQty": 0,
"TransferFromStoreId": null,
"TransferFromStoreName": "",
"TransferProcessedFlag": false,
"TransferSoId": null,
"TransferSoNumber": "",
"TransferToStoreId": null,
"TxnId": "",
"TxnNumber": 0,
"TxnTypeId": null,
"TypeId": 10,
"TypeName": "Purchase",
"VendorContact": "",
"VendorId": 1953,
"VendorMsg": "",
"VendorName": "Test Vendor",
"VendorReqDate": "03/26/2021"
},
"poLines": [
{
"AlternativeItemNumber1": "",
"AlternativeItemNumber2": "",
"AlternativeItemNumber3": "",
"Amount": 108,
"BasePartNumber": "00002",
"CancelledFlag": false,
"CloseFlag": false,
"CreateDateTime": null,
"CreateSource": null,
"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": "03/26/2021",
"DateLastFulFilled": null,
"DeleteFlag": false,
"Description": "1234",
"Discount": 10,
"DiscountDisp": "10%",
"DiscountTypeId": 10,
"DiscountTypeName": null,
"EditState": true,
"EffectiveUnitPrice": 108,
"ExpectedShipDate": null,
"Id": 48582,
"IsKitHeader": false,
"IsKitItem": false,
"IsTaxableFlag": true,
"ItemBarcode": "",
"ItemUpc": "",
"KitItemFactor": 1,
"LineStatusId": 10,
"LineStatusName": "Open",
"MasterKitId": null,
"MasterKitKey": "",
"ModifyDateTime": null,
"ModifySource": null,
"Notes": "Test Notes",
"OpenFlag": true,
"Option1Name": "Yarn Type",
"Option1Value": "2/28 Regular",
"Option1ValueCode": "2/28",
"Option2Name": "Yarn Color",
"Option2Value": "Brown",
"Option2ValueCode": "BRN",
"OrderLineClassCode": null,
"OrderLineClassName": null,
"PoId": 22489,
"PoItemId": 67223,
"PoItemNumber": "123",
"PoItemTypeId": 10,
"PoItemTypeName": "Inventory",
"PoLineNumber": 1,
"ProjectClassId": 0,
"ProjectClassName": "",
"QtyDecimalFlag": false,
"QtyInReceiving": 0,
"QtyOrder": 1,
"QtyReceived": 0,
"QtyRemaining": 1,
"RefId": null,
"SoId": null,
"SoLineId": null,
"TaxAmount": 65.25,
"TaxCodeId": null,
"TaxCodeName": "",
"TaxData": null,
"TaxItems": null,
"Title": "ACRYLIC",
"TotalInReceiving": null,
"TxnTypeId": null,
"UnitPrice": 120,
"UomId": 4,
"UomName": "",
"VendorId": null,
"VendorPartNumber": ""
},
{
"AlternativeItemNumber1": "",
"AlternativeItemNumber2": "",
"AlternativeItemNumber3": "",
"Amount": 108,
"BasePartNumber": "00002",
"CancelledFlag": false,
"CloseFlag": false,
"CreateDateTime": null,
"CreateSource": null,
"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": "03/26/2021",
"DateLastFulFilled": null,
"DeleteFlag": false,
"Description": "1234",
"Discount": 10,
"DiscountDisp": "10%",
"DiscountTypeId": 10,
"DiscountTypeName": null,
"EditState": true,
"EffectiveUnitPrice": 108,
"ExpectedShipDate": null,
"Id": 48582,
"IsKitHeader": false,
"IsKitItem": false,
"IsTaxableFlag": true,
"ItemBarcode": "",
"ItemUpc": "",
"KitItemFactor": 1,
"LineStatusId": 10,
"LineStatusName": "Open",
"MasterKitId": null,
"MasterKitKey": "",
"ModifyDateTime": null,
"ModifySource": null,
"Notes": "Test Notes",
"OpenFlag": true,
"Option1Name": "Yarn Type",
"Option1Value": "2/28 Regular",
"Option1ValueCode": "2/28",
"Option2Name": "Yarn Color",
"Option2Value": "Brown",
"Option2ValueCode": "BRN",
"OrderLineClassCode": null,
"OrderLineClassName": null,
"PoId": 22489,
"PoItemId": 67223,
"PoItemNumber": "123",
"PoItemTypeId": 10,
"PoItemTypeName": "Inventory",
"PoLineNumber": 1,
"ProjectClassId": 0,
"ProjectClassName": "",
"QtyDecimalFlag": false,
"QtyInReceiving": 0,
"QtyOrder": 1,
"QtyReceived": 0,
"QtyRemaining": 1,
"RefId": null,
"SoId": null,
"SoLineId": null,
"TaxAmount": 65.25,
"TaxCodeId": null,
"TaxCodeName": "",
"TaxData": null,
"TaxItems": null,
"Title": "ACRYLIC",
"TotalInReceiving": null,
"TxnTypeId": null,
"UnitPrice": 120,
"UomId": 4,
"UomName": "",
"VendorId": null,
"VendorPartNumber": ""
}
]
}Last updated
Was this helpful?