api/PurchaseOrder/Query (POST)

Queries existing Purchase Orders using the provided query data.
HTTP Method: POST
Required Fields: At least one field in PurchaseOrder or PurchaseOrderLine as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Purchase Orders.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Purchase Order query data.

Query Single Purchase Order Using Key Fields Example:
{
  "PurchaseOrder": {
    "PO_ID": "123456"
  }
}
Returns 1 Purchase Order if successful.
This is like 'Find' in Expandable.

Query Multiple Purchase Orders Using Other Fields Example:
{
  "PurchaseOrder": {
    "VENDOR_ID": "XYZCORP",
    "PO_TYPE": "N"
  }
}
Returns 1 or more Purchase Orders if successful.
This is like 'QBE' in Expandable.

Query Multiple Purchase Orders Using QBE Conditional Notation Example:
{
  "PurchaseOrder": {
    "VENDOR_ID": "XYZCORP",
    "PO_TYPE": "IN 'N','CR'"
  }
}
Returns 1 or more Purchase Orders if successful.
This is like 'QBE' in Expandable.

Query Multiple Purchase Orders Using Only Line Criteria Example:
{
  "PurchaseOrderLine": {
    "PART_ID": "MOTOR003"
  }
}
Returns 1 or more Purchase Orders if successful.
This is like 'QBE' in Expandable.

Query Multiple Purchase Orders Using Both Header and Line Criteria Example:
{
  "PurchaseOrder": {
    "VENDOR_ID": "XYZCORP"
  },
  "PurchaseOrderLine": {
    "PART_ID": "MOTOR003"
  }
}
Returns 1 or more Purchase Orders if successful.
This is like 'QBE' in Expandable.

Note: Purchase Order Comment and Purchase Order Extended User cannot be used as query criteria.

Accepted Purchase Order Fields:
BILL_TO_ID, BLANKET_ID, BUYER_ID, CHANGE_CODE, 
CHANGE_DATE, CHANGE_NO, CONFIRMED_TO, CREATED_BY, 
CURR_CODE, CURR_RATE, DATE_CREATED, DATE_LAST_EDI, 
DATE_LAST_PRINT, DATE_LAST_UPDT, DATE_MODIFIED, DROP_SHIP_ID, 
E_MAIL, E_MAIL_DATE, FOB, FREIGHT_CODE, 
LAST_REL_ID, MODIFIED_BY, NUMBER_BOXES, NUMBER_CARTONS, 
OPERATOR_ID, ORDER_CLASS, ORDER_DATE, ORDER_DISC_PCT, 
ORIG_PO_AMT, PAYMENTS_MADE, PO_EXPIRATION, PO_EXPIRE_DATE, 
PO_HOLD, PO_ID, PO_LIMIT_AMT, PO_STATUS, 
PO_TYPE, POFOM_USER_1, POFOM_USER_2, POFOM_USER_3, 
POFOM_USER_4, POFOM_USER_5, POFOM_USER_6, POFOM_USER_7, 
POFOM_USER_8, POFOM_USER_9, POFOM_USER_10, POFOM_USER_11, 
POFOM_USER_12, POFOM_USER_13, POFOM_USER_14, POFOM_USER_15, 
POFOM_USER_16, POFOM_USER_17, POFOM_USER_18, POFOM_USER_19, 
POFOM_USER_20, POFOM_USER_21, POFOM_USER_22, POFOM_USER_23, 
POFOM_USER_24, POFOM_USER_25, POFOM_USER_26, POFOM_USER_27, 
POFOM_USER_28, POFOM_USER_29, POFOM_USER_30, POFOM_USER_31, 
POFOM_USER_32, POFOM_USER_33, POFOM_USER_34, POFOM_USER_35, 
POFOM_USER_36, POFOM_USER_37, POFOM_USER_38, POFOM_USER_39, 
POFOM_USER_40, REFERENCE, REVISED_PO_AMT, SHIP_METHOD, 
TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, TOTAL_BOXES, 
TOTAL_REL_AMT, TOTAL_RELEASES, VENDOR_ID, VENDOR_NAME, 
WEIGHT

Accepted Purchase Order Line Fields:
ACCEPTED_QTY, ACCOUNT, AMOUNT, BALANCE_DUE, 
BILL_OF_LADING, BLANKET_LINE, BOX_NUMBER, BUY_CONV, 
BUY_DEC, CHANGE_CODE, CHANGE_DATE, CHANGE_NO, 
COMPANY_ID, CREATED_BY, DATE_CREATED, DATE_LAST_ACT, 
DATE_LAST_UPDT, DATE_MODIFIED, DELIVERY_DATE, DEPARTMENT, 
DM_PRINT_DATE, DWG_REV, EARLY_RECEIPT, ECN, 
INV_ACPT_QTY, INV_BAL_DUE, INV_MRB_QTY, INV_ORDER_QTY, 
INV_QC_QTY, INV_RECV_QTY, INV_RETN_QTY, INV_REVISED_QTY, 
INV_SCRP_QTY, ITEM_DISC_PCT, JOB_ID, KIT_UPDATE, 
LC_AMOUNT, LC_UNIT_PRICE, LINE_NUMBER, LINE_ORDER_DISC, 
LINE_TAX_2, LINE_TAX_3, LINE_TAX_4, LINE_TAX_5, 
LINE_TAX_6, LINE_TAX_7, LINE_TAX_8, LINE_TAX_9, 
LINE_TAX_10, LINE_TAX_AMT, LINE_VAT, MODIFIED_BY, 
MRB_BAL_QTY, OPER_CODE, OPERATOR_ID, ORDER_QTY, 
PART_ID, PART_UM, PARTIAL_SHIP, PO_DESC, 
PO_ID, PO_LINE_CAT, PO_LINE_HOLD, PO_LINE_STATUS, 
PO_UM, PO_UNIT_PRICE, POFOD_USER_1, POFOD_USER_2, 
POFOD_USER_3, POFOD_USER_4, POFOD_USER_5, POFOD_USER_6, 
POFOD_USER_7, POFOD_USER_8, POFOD_USER_9, POFOD_USER_10, 
POFOD_USER_11, POFOD_USER_12, POFOD_USER_13, POFOD_USER_14, 
POFOD_USER_15, POFOD_USER_16, PRICE_CODE, QC_BAL_QTY, 
QC_FLAG, RECEIVED_QTY, REQ_DEL_DATE, REQ_LINE_NO, 
REQUESTOR, REQUISITION_NO, RETURN_QTY, REV_DEL_DATE, 
REV_ORDER_QTY, SCRAPPED_QTY, SHIP_TRAC_NO, SHIP_VIA, 
SHIPMENT_NO, SO_CREATED, SO_ID, SO_LINE_NO, 
STOCK_BUY_FLAG, STORES_CODE, TAX_CODE, TIME_LAST_UPDT, 
VAT_CODE, VENDOR_PART_ID

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Purchase Orders.

Error:
400/Request JSON is invalid.
400/Request has no Purchase Order Header or Line Criteria.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Purchase Order Fields:
ATTACHMENTS, BILL_NAME, BILL_TO_ID, BLANKET_ID, BUYER_ID, CHANGE_CODE, CHANGE_DATE, CHANGE_NO, CONFIRMED_TO, CREATED_BY, CURR_CODE, CURR_RATE, DATE_CREATED, DATE_LAST_EDI, DATE_LAST_PRINT, DATE_LAST_UPDT, DATE_MODIFIED, DROP_SHIP_ID, E_MAIL, E_MAIL_DATE, FOB, FREIGHT_CODE, LAST_REL_ID, MODIFIED_BY, NOTES, NUMBER_BOXES, NUMBER_CARTONS, OPERATOR_ID, ORDER_CLASS, ORDER_DATE, ORDER_DISC_AMT, ORDER_DISC_PCT, ORDER_SUBTOTAL, ORDER_TAX_2, ORDER_TAX_3, ORDER_TAX_4, ORDER_TAX_5, ORDER_TAX_6, ORDER_TAX_7, ORDER_TAX_8, ORDER_TAX_9, ORDER_TAX_10, ORDER_TAX_AMT, ORDER_TOTAL, ORDER_VAT, ORIG_PO_AMT, PAYMENTS_MADE, PO_EXPIRATION, PO_EXPIRE_DATE, PO_HOLD, PO_ID, PO_LIMIT_AMT, PO_STATUS, PO_TYPE, POFOM_USER_1, POFOM_USER_2, POFOM_USER_3, POFOM_USER_4, POFOM_USER_5, POFOM_USER_6, POFOM_USER_7, POFOM_USER_8, POFOM_USER_9, POFOM_USER_10, POFOM_USER_11, POFOM_USER_12, POFOM_USER_13, POFOM_USER_14, POFOM_USER_15, POFOM_USER_16, POFOM_USER_17, POFOM_USER_18, POFOM_USER_19, POFOM_USER_20, POFOM_USER_21, POFOM_USER_22, POFOM_USER_23, POFOM_USER_24, POFOM_USER_25, POFOM_USER_26, POFOM_USER_27, POFOM_USER_28, POFOM_USER_29, POFOM_USER_30, POFOM_USER_31, POFOM_USER_32, POFOM_USER_33, POFOM_USER_34, POFOM_USER_35, POFOM_USER_36, POFOM_USER_37, POFOM_USER_38, POFOM_USER_39, POFOM_USER_40, REFERENCE, REVISED_PO_AMT, SHIP_METHOD, SHIP_NAME, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, TOTAL_BOXES, TOTAL_REL_AMT, TOTAL_RELEASES, VENDOR_ID, VENDOR_NAME, WEIGHT

Returned Purchase Order Line Fields:
ACCEPTED_QTY, ACCOUNT, AMOUNT, APPR_MFG_LEVEL, APPR_VEND_LEVEL, BALANCE_DUE, BILL_OF_LADING, BLANKET_LINE, BOX_NUMBER, BUY_CONV, BUY_DEC, CHANGE_CODE, CHANGE_DATE, CHANGE_NO, COMPANY_ID, CREATED_BY, CURR_CODE, DATE_CREATED, DATE_LAST_ACT, DATE_LAST_UPDT, DATE_MODIFIED, DELIVERY_DATE, DEPARTMENT, DM_PRINT_DATE, DWG_REV, EARLY_RECEIPT, ECN, INV_ACPT_QTY, INV_BAL_DUE, INV_MRB_QTY, INV_ORDER_QTY, INV_QC_QTY, INV_RECV_QTY, INV_RETN_QTY, INV_REVISED_QTY, INV_SCRP_QTY, ITEM_DISC_PCT, JOB_ID, KIT_UPDATE, LC_AMOUNT, LC_UNIT_PRICE, LINE_NUMBER, LINE_ORDER_DISC, LINE_TAX_2, LINE_TAX_3, LINE_TAX_4, LINE_TAX_5, LINE_TAX_6, LINE_TAX_7, LINE_TAX_8, LINE_TAX_9, LINE_TAX_10, LINE_TAX_AMT, LINE_VAT, MFG_VENDOR_ID, MODIFIED_BY, MRB_BAL_QTY, OPER_CODE, OPERATOR_ID, ORDER_QTY, PART_DESC, PART_ID, PART_UM, PARTIAL_SHIP, PO_DESC, PO_ID, PO_LINE_CAT, PO_LINE_HOLD, PO_LINE_STATUS, PO_UM, PO_UNIT_PRICE, POFOD_USER_1, POFOD_USER_2, POFOD_USER_3, POFOD_USER_4, POFOD_USER_5, POFOD_USER_6, POFOD_USER_7, POFOD_USER_8, POFOD_USER_9, POFOD_USER_10, POFOD_USER_11, POFOD_USER_12, POFOD_USER_13, POFOD_USER_14, POFOD_USER_15, POFOD_USER_16, PRICE_CODE, QC_BAL_QTY, QC_FLAG, QC_SAMPLE_CODE, RECEIVED_QTY, REQ_DEL_DATE, REQ_LINE_NO, REQUESTOR, REQUISITION_NO, RETURN_QTY, REV_DEL_DATE, REV_ORDER_QTY, SCRAPPED_QTY, SHIP_TRAC_NO, SHIP_VIA, SHIPMENT_NO, SO_CREATED, SO_ID, SO_LINE_NO, STOCK_BUY_FLAG, STORES_CODE, TAX_CODE, TIME_LAST_UPDT, VAT_CODE, VENDOR_PART_ID

Returned Purchase Order Comment Fields:
COMMENT_TEXT, CREATED_BY, DATE_CREATED, DATE_LAST_UPDT, PO_ID, DATE_MODIFIED, MODIFIED_BY, PO_LINE_NO, PRINT_PO, TIME_LAST_UPDT

Returned Purchase Order Extended User Fields:
CREATED_BY, DATE_CREATED, DATE_MODIFIED, LINE_NUMBER, MODIFIED_BY, PO_ID, POFDXU_USER_1, POFDXU_USER_2, POFDXU_USER_3, POFDXU_USER_4, POFDXU_USER_5, POFDXU_USER_6, POFDXU_USER_7, POFDXU_USER_8, POFDXU_USER_9, POFDXU_USER_10, POFDXU_USER_11, POFDXU_USER_12, POFDXU_USER_13, POFDXU_USER_14, POFDXU_USER_15, POFDXU_USER_16, POFDXU_USER_17, POFDXU_USER_18, POFDXU_USER_19, POFDXU_USER_20, POFDXU_USER_21, POFDXU_USER_22, POFDXU_USER_23, POFDXU_USER_24, POFDXU_USER_25, POFDXU_USER_26, POFDXU_USER_27, POFDXU_USER_28, POFDXU_USER_29, POFDXU_USER_30, POFDXU_USER_31, POFDXU_USER_32, POFDXU_USER_33, POFDXU_USER_34, POFDXU_USER_35, POFDXU_USER_36, POFDXU_USER_37, POFDXU_USER_38, POFDXU_USER_39, POFDXU_USER_40, POFDXU_USER_41, POFDXU_USER_42, POFDXU_USER_43, POFDXU_USER_44, POFDXU_USER_45, POFDXU_USER_46, POFDXU_USER_47, POFDXU_USER_48