# Purchase Order **Purchase Order Header:** | Name | Data Type | Description | | ----------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ThirdPartyRefNo` | string, required | A reference number for the order. If an order in Xoro 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. | | `StoreName` | string | It is Ship Store’s (inventory set) name here exactly as it is in Xoro. | | `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 Xoro. | | `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 Xoro for the PO here.Common terms include:Net 30,Credit Card. | | `CustomFieldH1` | string | Custom Fields (CustomFieldH1 - CustomFieldH50). | **Purchase Order Line:** | Name | Data Type | Description | | -------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ | | `PoItemNumber` | 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 - CustomFieldD50). | **uccCartonArr:** | Name | Data Type | Description | | -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | LineIdentifier | int | The term "LineIdentifier" is used to denote the position of a line within a set of purchase order lines (poLines). For example, for the first line in the purchase order lines, the LineIdentifier would be 1. Similarly, for the second line in the purchase order, the LineIdentifier would be 2, and so on. Essentially, it serves as a numerical marker indicating the sequence or order of each line within the purchase order. | | UCC | string | The unique carton code (UCC) associated with the carton to be received. | | PalletUCC | string | The unique pallet carton code (Pallet UCC) associated with the carton to be received. | **JSON Example** ```json { "poHeader": { "Account3PLCode": null, "Account3PLId": 1, "ApproverName": null, "AsnNotes": null, "AsnNumbers": null, "AutoGenerateAsn": true, "AutoReleasePurchaseOrder": false, "BillFromAddress": "333 E King Edward Ave", "BillFromAddress2": "333 E King Edward Ave", "BillFromCity": "Vancouver", "BillFromCompanyName": "", "BillFromCountry": "Canada", "BillFromEmail": "test@yopmail.com", "BillFromFirstName": "Harry", "BillFromLastName": "Cad", "BillFromName": "Harry", "BillFromPhoneNumber": "16848504725", "BillFromPostalZipCode": "V5V 2C4", "BillFromState": "BC", "BuyerId": null, "BuyerName": "", "CarrierId": null, "CarrierName": "", "CombineLines": false, "CreateDateTime": "01/28/2024 09:06:01 PM", "CreateSource": "test", "CurrencyCode": "CAD", "CurrencyId": 1, "CurrencyRate": 1, "CurrencySymbol": "$ ", "Customer3PLMainEmail": null, "CustomFieldH1": "", "CustomFieldH10": "", "CustomFieldH11": "", "CustomFieldH12": "", "CustomFieldH13": "", "CustomFieldH14": "", "CustomFieldH15": "", "CustomFieldH16": "", "CustomFieldH17": "", "CustomFieldH18": "", "CustomFieldH19": "", "CustomFieldH2": "", "CustomFieldH20": "", "CustomFieldH21": "", "CustomFieldH22": "", "CustomFieldH23": "", "CustomFieldH24": "", "CustomFieldH25": "", "CustomFieldH26": "", "CustomFieldH27": "", "CustomFieldH28": "", "CustomFieldH29": "", "CustomFieldH3": "", "CustomFieldH30": "", "CustomFieldH31": "", "CustomFieldH32": "", "CustomFieldH33": "", "CustomFieldH34": "", "CustomFieldH35": "", "CustomFieldH36": "", "CustomFieldH37": "", "CustomFieldH38": "", "CustomFieldH39": "", "CustomFieldH4": "", "CustomFieldH40": "", "CustomFieldH41": "", "CustomFieldH42": "", "CustomFieldH43": "", "CustomFieldH44": "", "CustomFieldH45": "", "CustomFieldH46": "", "CustomFieldH47": "", "CustomFieldH48": "", "CustomFieldH49": "", "CustomFieldH5": "", "CustomFieldH50": "", "CustomFieldH6": "", "CustomFieldH7": "", "CustomFieldH8": "", "CustomFieldH9": "", "DateExpectedDelivery": "01/28/2024", "DateFulFilled": null, "DateOrder": "01/28/2024", "DateReleased": "01/28/2024", "DefaultLocationId": null, "DefaultLocationName": "", "DiscountAmount": 0, "DropShipCustomerId": null, "DropShipCustomerName": "", "DropshipFreightAmount": null, "ExpectedShipDate": "01/28/2024", "FobId": null, "FobName": null, "FromStoreDefaultLocationName": null, "IsAccount3plApiRequest": false, "IsApprovalRequiredFlag": false, "IsApproved": false, "IsClosed": false, "IsDropShip": false, "ItemQualityCode": null, "LastApprovedAmount": 0, "LastApprovedDateTime": null, "LastApprovedSource": null, "LineCount": 0, "LinkedSO": null, "LinkSOToPO": false, "MainEmail": null, "MainPhone": null, "Memo": "", "ModifyDateTime": null, "ModifySource": "", "MoNumbers": null, "OpenPageFromSO": false, "OrderClassCode": null, "OrderClassName": null, "OrderNumber": "P000059", "PaymentTermsId": null, "PaymentTermsName": null, "POApprovalStatus": null, "PoSubTypeId": null, "PoSubTypeName": "", "ProjectClassId": null, "ProjectClassName": "", "QualityId": null, "ReceivingStatusId": 0, "ReceivingStatusName": null, "RefId": null, "RefNumber": "", "ReportDataObj": { "EntityAccntId": "1B234234A-350A-4417-8447-099A1619344D", "EntityName": "Test", "EntityObj": null, "linkedTxnRefId": null, "ReportEntityId": 105, "TxnRefId": 676, "TxnRefNumber": "P000059", "TxnTypeId": 114 }, "ShipFromAddress": null, "ShipFromAddress2": null, "ShipFromCity": null, "ShipFromCountry": null, "ShipFromPostalZipCode": null, "ShipFromState": null, "ShipMethodId": null, "ShipMethodName": "", "ShippingAccountNumber": "", "ShippingTermsId": null, "ShippingTermsName": null, "ShipServiceId": null, "ShipServiceName": "", "ShipToAddress": "7688 132 St", "ShipToAddress2": "", "ShipToAddrName": null, "ShipToCity": "Surrey", "ShipToCompanyName": "Test Inc.", "ShipToCountry": "Canada", "ShipToEmail": "", "ShipToFirstName": "", "ShipToLastName": "", "ShipToName": "", "ShipToPhoneNumber": "666-934-0252", "ShipToPostalZipCode": "V3W 4M9", "ShipToState": "BC", "StatusId": 20, "StatusName": "Released", "StoreId": 10006, "StoreName": "Test store", "SubTotal": 0, "SubTotalExclDiscount": 0, "Tags": "", "TaxServiceHashCode": 0, "TaxServiceHashCodeOld": 0, "TaxSummaryDataText": null, "ThirdPartyDisplayName": "", "ThirdPartyIconUrl": "", "ThirdPartyRefNo": "", "ThirdPartySource": "", "ToStoreDefaultLocationId": null, "ToStoreDefaultLocationName": "", "TotalAmount": 0, "TotalEstimatedDutyAmount": null, "TotalPrepayment": 0, "TotalQty": 0, "TransferFromStoreId": null, "TransferFromStoreName": "", "TransferProcessedFlag": false, "TransferSoId": null, "TransferSoNumber": "", "TransferToStoreId": null, "TxnId": "", "TxnNumber": 0, "TxnTypeId": null, "TypeId": 10, "TypeName": "Purchase", "UpdateEnable": false, "UpdateFromSo": false, "Vendor3PLTypeId": 0, "Vendor3PLTypeName": null, "VendorContact": "Test", "VendorEmailCC": null, "VendorEmailMain": null, "VendorId": 137, "VendorMsg": "", "VendorName": "Test", "VendorPartNumber": null, "VendorReqDate": "01/28/2024", "VoidAndCreate": false }, "poLines": [ { "Account3plId": 1, "AllowedPurchaseUOMList": null, "AlternativeItemNumber1": "1005393Test", "AlternativeItemNumber2": "D.100.5393.931.LG", "AlternativeItemNumber3": "", "Amount": 0, "BasePartNumber": "1005393", "BaseQtyOrdered": null, "BaseQtyRemainingToShip": null, "BaseQtyShipped": null, "BaseUomId": 4, "BaseUomName": null, "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": "", "CustomFieldD31": "", "CustomFieldD32": "", "CustomFieldD33": "", "CustomFieldD34": "", "CustomFieldD35": "", "CustomFieldD36": "", "CustomFieldD37": "", "CustomFieldD38": "", "CustomFieldD39": "", "CustomFieldD4": "", "CustomFieldD40": "", "CustomFieldD41": "", "CustomFieldD42": "", "CustomFieldD43": "", "CustomFieldD44": "", "CustomFieldD45": "", "CustomFieldD46": "", "CustomFieldD47": "", "CustomFieldD48": "", "CustomFieldD49": "", "CustomFieldD5": "", "CustomFieldD50": "", "CustomFieldD6": "", "CustomFieldD7": "", "CustomFieldD8": "", "CustomFieldD9": "", "DateExpectedDelivery": "01/28/2024", "DateLastFulFilled": null, "DefaultPurchaseUomId": 0, "DeleteFlag": false, "Description": "Test Desc", "Discount": null, "DiscountDisp": "", "DiscountTypeId": null, "DiscountTypeName": null, "DropshipSoId": null, "DropshipSoLineId": null, "DropshipSoNumber": "", "EditState": true, "EffectiveUnitPrice": 0, "EstimatedDutyAmount": 0, "EstimatedDutyPercentage": null, "ExpectedShipDate": "01/28/2024", "Id": 21808, "IsBomItemFlag": false, "IsKitHeader": false, "IsKitItem": false, "IsProducibleFlag": false, "IsTaxableFlag": true, "ItemBarcode": "", "ItemCategoryName": "Accessories 1 - Small", "ItemIdentifierCode": null, "ItemQualityCode": null, "ItemSubCategoryName": "Backpacks", "ItemUpc": "19423400", "KitItemFactor": 1, "LineStatusId": 20, "LineStatusName": "Released", "MasterKitId": null, "MasterKitKey": "", "ModifyDateTime": null, "ModifySource": null, "Notes": "", "OpenFlag": false, "Option1Name": "Color", "Option1Value": "O1", "Option1ValueCode": "OC1", "Option2Name": "Size", "Option2Value": "L", "Option2ValueCode": "L", "OrderLineClassCode": null, "OrderLineClassName": null, "PoId": 676, "PoItemId": 127082, "PoItemNumber": "192348700", "PoItemTypeId": 10, "PoItemTypeName": "Inventory", "PoLineNumber": 1, "ProjectClassId": null, "ProjectClassName": "", "PurchaseNotes": "", "QtyDecimalFlag": false, "QtyInReceiving": 0, "QtyOrder": 5, "QtyReceived": 0, "QtyRemaining": 5, "QualityId": null, "RefId": null, "SoId": null, "SoLineId": null, "TaxAmount": 0, "TaxCategoryCode": null, "TaxCodeId": null, "TaxCodeName": "", "TaxData": { "taxItems": [], "totalAmount": 0 }, "TaxItems": null, "Title": "Test", "TotalInReceiving": null, "TransferSoLineId": null, "TxnTypeId": null, "UnitPrice": 0, "UomFactor": 1, "UomId": 4, "UomName": "Each", "VendorId": null, "VendorPartNumber": "" } ], "uccCartonArr": [ { "LineIdentifier": 1, "UCC": "TLPN00001", "Qty": 5, "PalletUCC": "TP_UCC" } ] }} ``` --- # Agent Instructions: 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: ``` GET https://3plmanagerdocs.xorosoft.io/data-models/purchase-order.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.