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.

get

Authorizations

AuthorizationstringRequired

Query parameters

idnumberOptional

A comma-separated list of purchase order ids

order_numberstringOptional

A comma-separated list of purchase order numbers

vendor_namestringOptional

A comma-separated list of vendor names

since_idstringOptional

Restrict results to after the specified ID

created_at_minstringOptional

Show purchase orders created at or after date (format: 2014-04-25T16:15:47-04:00)

updated_at_minstringOptional

Show purchase orders updated at or after date (format: 2014-04-25T16:15:47-04:00)

created_at_maxstringOptional

Show purchase orders created at or before date (format: 2014-04-25T16:15:47-04:00)

updated_at_maxstringOptional

Show purchase orders updated at or before date (format: 2014-04-25T16:15:47-04:00)

statusstringOptional

A comma-separated list of statuses

store_namestringOptional

Store or warehouse name.

third_party_ref_nostringOptional

Third-party reference number supplied by the external system.

ref_nostringOptional

Reference number used to find matching documents or transactions.

pagestringOptional

Page number for paginated responses.

Default: 1

account3pl_idstringOptional

3PL account identifier.

exclude_processedbooleanOptional

When true, excludes records already marked as processed.

Default: false

vendor_idstringOptional

Vendor identifier in Xorosoft ERP.

vendor_bill_numbersstringOptional

Comma-separated vendor bill numbers.

vendor_po_numbersstringOptional

Comma-separated vendor purchase order numbers.

Responses

200

OK

application/json

IsForwardRequestbooleanOptional

MessagestringOptional

MessageTitlestring · nullableOptional

ResultbooleanOptional

get/api/xerp/purchaseorder/getpurchaseorder

GET /api/xerp/purchaseorder/getpurchaseorder HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*

200

OK

{
  "Data": [
    {
      "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": 1322,
        "CarrierName": "FedEx",
        "CombineLines": false,
        "CreateDateTime": "03/26/2021 07:20:59 PM",
        "CreateSource": "xoro@sushil",
        "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": "03/26/2021",
        "FobId": 10,
        "FobName": null,
        "FromStoreDefaultLocationName": null,
        "Id": 22488,
        "IsClosed": false,
        "LineCount": 0,
        "LinkSOToPO": false,
        "MainEmail": null,
        "MainPhone": null,
        "Memo": "",
        "ModifyDateTime": null,
        "ModifySource": "",
        "OpenPageFromSO": false,
        "OrderClassCode": null,
        "OrderClassName": null,
        "OrderNumber": "MAIN-P002353",
        "PaymentTermsId": 69,
        "PaymentTermsName": null,
        "PoSubTypeId": 5,
        "PoSubTypeName": "Appliances",
        "ProjectClassId": 1,
        "ProjectClassName": "Online",
        "RefId": null,
        "RefNumber": "",
        "ReportDataObj": {
          "EntityAccntId": "372642B0-E5BB-4B25-8A1D-DE313839D850",
          "EntityName": "Test Vendor",
          "ReportEntityId": 105,
          "TxnRefId": 22488,
          "TxnRefNumber": "MAIN-P002353",
          "TxnTypeId": 114,
          "linkedTxnRefId": null
        },
        "ShipMethodId": 30,
        "ShipMethodName": "Delivery (Third Party)",
        "ShipServiceId": 121,
        "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",
        "ShippingAccountNumber": "",
        "ShippingTermsId": 30,
        "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": 965.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": 900,
          "BasePartNumber": "Article_Test_5",
          "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": "Article_Test_1 Article_Test_1-b-xxl",
          "Discount": 10,
          "DiscountDisp": "10%",
          "DiscountTypeId": 10,
          "DiscountTypeName": null,
          "EditState": true,
          "EffectiveUnitPrice": 90,
          "ExpectedShipDate": "03/26/2021",
          "Id": 48581,
          "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": "Color-N",
          "Option1Value": "blue",
          "Option1ValueCode": "b",
          "Option2Name": "size-n",
          "Option2Value": "xxl",
          "Option2ValueCode": "xxl",
          "OrderLineClassCode": null,
          "OrderLineClassName": null,
          "PoId": 22488,
          "PoItemId": 64413,
          "PoItemNumber": "Article_Test_5-b-xxl",
          "PoItemTypeId": 10,
          "PoItemTypeName": "Inventory",
          "PoLineNumber": 1,
          "ProjectClassId": 1,
          "ProjectClassName": "Online",
          "QtyDecimalFlag": true,
          "QtyInReceiving": 0,
          "QtyOrder": 10,
          "QtyReceived": 0,
          "QtyRemaining": 10,
          "RefId": null,
          "SoId": null,
          "SoLineId": null,
          "TaxAmount": 65.25,
          "TaxCodeId": 1008,
          "TaxCodeName": "ALPINE CO. 7.25%",
          "TaxData": null,
          "TaxItems": null,
          "Title": "Article_Test_5",
          "TotalInReceiving": null,
          "TxnTypeId": null,
          "UnitPrice": 100,
          "UomId": 6,
          "UomName": "Centimetre",
          "VendorId": null,
          "VendorPartNumber": ""
        }
      ]
    }
  ],
  "IsForwardRequest": false,
  "Message": "Order data loaded successfully",
  "MessageTitle": null,
  "Result": true
}