Receipt Transaction, Query
Queries existing Receipt Transactions using the provided criteria and returns a list of found Receipt Transactions.
URL
/api/receipt-transaction-query
Request Method
POST
Expandable Program
Receipt Transactions (POIRTG)
Required Fields
(at least one field to be used as query criteria)
AUTH_TOKEN
AUTH_TOKEN
Auth Token
This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.
Example Request JSON
{
"PO_ID": "100414",
"ACTION_TYPE": "PO",
"AUTH_TOKEN": ""
}
Full Request JSON
{
"PO_ID": "",
"LINE_NUMBER": "",
"ACTION_DATE": "",
"PART_ID": "",
"VENDOR_ID": "",
"BATCH_NUMBER": "",
"ACTION_TYPE": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"REFERENCE": "",
"INV_QUANTITY": "",
"PART_UM": "",
"QUANTITY": "",
"PO_UM": "",
"GL_YEAR": "",
"GL_MONTH": "",
"LOT_ID": "",
"JOB_ID": "",
"OPER_CODE": "",
"REASON_CODE": "",
"INVOICE_ID": "",
"INVOICE_DATE": "",
"PART_DESC": "",
"VENDOR_NAME": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"TOTAL_STD_COST": "",
"QTY_INSPECTED": "",
"VENDR_SHIP_TIME": "",
"STD_MTL_CST_CUM": "",
"PO_UNIT_COST": "",
"AP_UNIT_COST": "",
"INVOICE_LN_QTY": "",
"DM_PRINT_DATE": "",
"BUY_CONV": "",
"BUY_DEC": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"PO_CURR_RATE": "",
"AP_CURR_RATE": "",
"PO_BC_RATE": "",
"AP_BC_RATE": "",
"BC_RATE": "",
"BC_TOTAL_STD": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"ACCRUAL_JV_DATE": "",
"ACCRUAL_JV_MO": "",
"ACCRUAL_JV_YR": "",
"POFRT_USER_1": "",
"POFRT_USER_2": "",
"POFRT_USER_3": "",
"POFRT_USER_4": "",
"PART_TYPE": "",
"SEARCH_NAME": "",
"DWG_REV": "",
"DWG_SIZE": "",
"ECN": "",
"ECN_EFF_DATE": "",
"PENDING_ECN": "",
"PLANNER_ID": "",
"BUYER_ID": "",
"PREF_VENDOR": "",
"AUTO_PO_CREATE": "",
"ABC_CODE": "",
"COMM_CODE": "",
"ICFPM_USER_1": "",
"ICFPM_USER_2": "",
"ICFPM_USER_3": "",
"ICFPM_USER_4": "",
"ICFPM_USER_5": "",
"ICFPM_USER_6": "",
"ICFPM_USER_7": "",
"ICFPM_USER_8": "",
"YIELD_FACTOR": "",
"DEF_STORES_CODE": "",
"ORDER_QTY": "",
"MAX_ORDER_QTY": "",
"VENDR_LEAD_TIME": "",
"RECEIVING_LT": "",
"KIT_LT": "",
"MFG_LT": "",
"SHIP_LT": "",
"PLAN_LEAD_TIME": "",
"CUM_LT": "",
"FORECAST_QTY": "",
"SO_ORDER_QTY": "",
"MIN_SALES_QTY": "",
"LOT_CONTROL": "",
"SHELF_LIFE": "",
"SN_REQD": "",
"WEIGHT": "",
"VOLUME": "",
"STOCK_DEC": "",
"BUY_UM": "",
"SALE_UM": "",
"SALE_CONV": "",
"SALE_DEC": "",
"SUBST_PART": "",
"PRODUCT_LINE": "",
"MRP_FLAG": "",
"MPS_CODE": "",
"CATG_CODE": "",
"PLAN_HORIZON": "",
"DAYS_SUPPLY": "",
"COMMENT_ID": "",
"PART_STATUS": "",
"PART_CLASS": "",
"DATE_CREATED": "",
"ORIG_REL_DATE": "",
"DATE_ACTIVE": "",
"DATE_OBSOLETE": "",
"TAXABLE": "",
"VAT_CODE": "",
"STD_OH_PCT_BUY": "",
"STD_OH_PCT_OUT": "",
"STD_WORK_1": "",
"STD_1_HRS": "",
"STD_WORK_2": "",
"STD_2_HRS": "",
"STD_WORK_3": "",
"STD_3_HRS": "",
"STD_LAB_HRS_ADD": "",
"STD_LAB_HRS_CUM": "",
"STD_LAB_CST_ADD": "",
"STD_LAB_CST_CUM": "",
"STD_MTL_CST_ADD": "",
"STD_OUT_CST_ADD": "",
"STD_OUT_CST_CUM": "",
"STD_OTH_CST_ADD": "",
"STD_OTH_CST_CUM": "",
"STD_OHD_CST_ADD": "",
"STD_OHD_CST_CUM": "",
"STD_UNIT_COST": "",
"BASE_CURR": "",
"BC_STD_COST": "",
"QTY_PER_CARTON": "",
"UPC_CODE": "",
"ITF_CODE": "",
"FRT_CLASS": "",
"WARRANTY_DAYS": "",
"SALES_MARKET": "",
"ORIG_COUNTRY": "",
"DATE_INACTIVE": "",
"PART_HOLD_CODE": "",
"SLX_PART": "",
"ICFPM_USER_9": "",
"ICFPM_USER_10": "",
"ICFPM_USER_11": "",
"ICFPM_USER_12": "",
"ICFPM_USER_13": "",
"ICFPM_USER_14": "",
"ICFPM_USER_15": "",
"ICFPM_USER_16": "",
"SN_REQD_INV": "",
"AL_PART_DESC": "",
"CATALOG_ID": "",
"CATALOG_DESC": "",
"AUTH_TOKEN": ""
}
QBE Notation
This query uses Expandable Query By Example (QBE) Notation. QBE Notation allows for conditional query criteria.
Not Equal To:
Greater Than:
Greater Than Or Equal To:
Less Than:
Less Than Or Equal To:
Between:
In:
Wildcard (any length):
Wildcard (single character):
Not Equal To:
"SO_STATUS": "<>X"
Greater Than:
"ON_HAND_QTY": ">0"
Greater Than Or Equal To:
"EFFECTIVE_DATE": ">=2016-01-01"
Less Than:
"AMOUNT": "<100"
Less Than Or Equal To:
"DATE_APPROVED": "<=2019-05-30"
Between:
"ORDER_QTY": "BETWEEN 10 AND 100"
In:
"LOT_STATUS": "IN A,C"
Wildcard (any length):
"PART_ID": "MOTOR%"
Wildcard (single character):
"SERIAL_NUMBER": "GC0000406_"
Success Response
Returned HTTP status indicates success:
200/OK
Returned JSON contains the Receipt Transactions which were found by the query:
200/OK
Returned JSON contains the Receipt Transactions which were found by the query:
[
{
"PO_ID": "",
"LINE_NUMBER": "",
"ACTION_DATE": "",
"PART_ID": "",
"VENDOR_ID": "",
"BATCH_NUMBER": "",
"ACTION_TYPE": "",
"STORES_CODE": "",
"STOCK_LOCATION": "",
"REFERENCE": "",
"INV_QUANTITY": "",
"PART_UM": "",
"QUANTITY": "",
"PO_UM": "",
"GL_YEAR": "",
"GL_MONTH": "",
"LOT_ID": "",
"JOB_ID": "",
"OPER_CODE": "",
"REASON_CODE": "",
"INVOICE_ID": "",
"INVOICE_DATE": "",
"PART_DESC": "",
"VENDOR_NAME": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"TOTAL_STD_COST": "",
"QTY_INSPECTED": "",
"VENDR_SHIP_TIME": "",
"STD_MTL_CST_CUM": "",
"PO_UNIT_COST": "",
"AP_UNIT_COST": "",
"INVOICE_LN_QTY": "",
"DM_PRINT_DATE": "",
"BUY_CONV": "",
"BUY_DEC": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"PO_CURR_RATE": "",
"AP_CURR_RATE": "",
"PO_BC_RATE": "",
"AP_BC_RATE": "",
"BC_RATE": "",
"BC_TOTAL_STD": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"ACCRUAL_JV_DATE": "",
"ACCRUAL_JV_MO": "",
"ACCRUAL_JV_YR": "",
"POFRT_USER_1": "",
"POFRT_USER_2": "",
"POFRT_USER_3": "",
"POFRT_USER_4": "",
"PART_TYPE": "",
"SEARCH_NAME": "",
"DWG_REV": "",
"DWG_SIZE": "",
"ECN": "",
"ECN_EFF_DATE": "",
"PENDING_ECN": "",
"PLANNER_ID": "",
"BUYER_ID": "",
"PREF_VENDOR": "",
"AUTO_PO_CREATE": "",
"ABC_CODE": "",
"COMM_CODE": "",
"ICFPM_USER_1": "",
"ICFPM_USER_2": "",
"ICFPM_USER_3": "",
"ICFPM_USER_4": "",
"ICFPM_USER_5": "",
"ICFPM_USER_6": "",
"ICFPM_USER_7": "",
"ICFPM_USER_8": "",
"YIELD_FACTOR": "",
"DEF_STORES_CODE": "",
"ORDER_QTY": "",
"MAX_ORDER_QTY": "",
"VENDR_LEAD_TIME": "",
"RECEIVING_LT": "",
"KIT_LT": "",
"MFG_LT": "",
"SHIP_LT": "",
"PLAN_LEAD_TIME": "",
"CUM_LT": "",
"FORECAST_QTY": "",
"SO_ORDER_QTY": "",
"MIN_SALES_QTY": "",
"LOT_CONTROL": "",
"SHELF_LIFE": "",
"SN_REQD": "",
"WEIGHT": "",
"VOLUME": "",
"STOCK_DEC": "",
"BUY_UM": "",
"SALE_UM": "",
"SALE_CONV": "",
"SALE_DEC": "",
"SUBST_PART": "",
"PRODUCT_LINE": "",
"MRP_FLAG": "",
"MPS_CODE": "",
"CATG_CODE": "",
"PLAN_HORIZON": "",
"DAYS_SUPPLY": "",
"COMMENT_ID": "",
"PART_STATUS": "",
"PART_CLASS": "",
"DATE_CREATED": "",
"ORIG_REL_DATE": "",
"DATE_ACTIVE": "",
"DATE_OBSOLETE": "",
"TAXABLE": "",
"VAT_CODE": "",
"STD_OH_PCT_BUY": "",
"STD_OH_PCT_OUT": "",
"STD_WORK_1": "",
"STD_1_HRS": "",
"STD_WORK_2": "",
"STD_2_HRS": "",
"STD_WORK_3": "",
"STD_3_HRS": "",
"STD_LAB_HRS_ADD": "",
"STD_LAB_HRS_CUM": "",
"STD_LAB_CST_ADD": "",
"STD_LAB_CST_CUM": "",
"STD_MTL_CST_ADD": "",
"STD_OUT_CST_ADD": "",
"STD_OUT_CST_CUM": "",
"STD_OTH_CST_ADD": "",
"STD_OTH_CST_CUM": "",
"STD_OHD_CST_ADD": "",
"STD_OHD_CST_CUM": "",
"STD_UNIT_COST": "",
"BASE_CURR": "",
"BC_STD_COST": "",
"QTY_PER_CARTON": "",
"UPC_CODE": "",
"ITF_CODE": "",
"FRT_CLASS": "",
"WARRANTY_DAYS": "",
"SALES_MARKET": "",
"ORIG_COUNTRY": "",
"DATE_INACTIVE": "",
"PART_HOLD_CODE": "",
"SLX_PART": "",
"ICFPM_USER_9": "",
"ICFPM_USER_10": "",
"ICFPM_USER_11": "",
"ICFPM_USER_12": "",
"ICFPM_USER_13": "",
"ICFPM_USER_14": "",
"ICFPM_USER_15": "",
"ICFPM_USER_16": "",
"SN_REQD_INV": "",
"AL_PART_DESC": "",
"CATALOG_ID": "",
"CATALOG_DESC": ""
}
]
Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Receipt Transaction query:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Receipt Transaction query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}
