AR Invoice Entry, Query
Queries existing AR Invoices using the provided criteria and returns a list of found AR Invoices.
URL
/api/ar-invoice-entry-query
Request Method
POST
Expandable Program
AR Invoice/Memo Entry (ARTIE)
Required Fields
HEADER:
(at least one field to be used as query criteria if none in LINES)
AUTH_TOKEN
LINES:
(at least one field to be used as query criteria if none in HEADER)
(at least one field to be used as query criteria if none in LINES)
AUTH_TOKEN
LINES:
(at least one field to be used as query criteria if none in HEADER)
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
{
"CUSTOMER_ID": "ABCCORP",
"INVOICE_TYPE": "SI",
"LINES": {
"PART_ID": "MOTOR003"
},
"AUTH_TOKEN": ""
}Full Request JSON
{
"INVOICE_NUMBER": "",
"CUSTOMER_ID": "",
"GL_YEAR": "",
"GL_MONTH": "",
"BATCH_NUMBER": "",
"INVOICE_TYPE": "",
"INVOICE_DATE": "",
"SO_ID": "",
"SO_TYPE": "",
"ORDER_CLASS": "",
"SOLD_TO_CUST": "",
"SHIP_TO_CUST": "",
"CUST_PO_ID": "",
"REFERENCE": "",
"AR_COMPANY_ID": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"INVOICE_AMT": "",
"INVOICE_FRT_AMT": "",
"INVOICE_TAX_AMT": "",
"INVOICE_TAX_2": "",
"INVOICE_TAX_3": "",
"INVOICE_TAX_4": "",
"INVOICE_TAX_5": "",
"INVOICE_TAX_6": "",
"INVOICE_TAX_7": "",
"INVOICE_TAX_8": "",
"INVOICE_TAX_9": "",
"INVOICE_TAX_10": "",
"INVOICE_VAT": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"BANK_CODE": "",
"PAYMENT_TYPE": "",
"BANK_CARD_GUID": "",
"CARD_TYPE": "",
"BANK_CARD_ID": "",
"EXPIRATION": "",
"TRANS_TYPE": "",
"AUTH_CODE": "",
"CARD_NAME": "",
"CARD_PHONE_NO": "",
"TERMS_CODE": "",
"DISCOUNT_AMT": "",
"DISCOUNT_DATE": "",
"DUE_DATE": "",
"NEXT_PAY_DATE": "",
"NEXT_PAY_AMT": "",
"NEXT_PAY_DISC": "",
"REMARK": "",
"TOTAL_AMT_PAID": "",
"TOTAL_MEMO_AMT": "",
"TOTAL_DISC_USED": "",
"TOTAL_DISC_LOST": "",
"CURRENT_BALANCE": "",
"NO_HOLD_FLAG": "",
"INVOICE_STATUS": "",
"DATE_LAST_PRINT": "",
"REPRINT_FLAG": "",
"ARFIM_USER_1": "",
"ARFIM_USER_2": "",
"ARFIM_USER_3": "",
"ARFIM_USER_4": "",
"ARFIM_USER_5": "",
"ARFIM_USER_6": "",
"ARFIM_USER_7": "",
"ARFIM_USER_8": "",
"ARFIM_USER_9": "",
"ARFIM_USER_10": "",
"ARFIM_USER_11": "",
"ARFIM_USER_12": "",
"ARFIM_USER_13": "",
"ARFIM_USER_14": "",
"ARFIM_USER_15": "",
"ARFIM_USER_16": "",
"ARFIM_USER_17": "",
"ARFIM_USER_18": "",
"ARFIM_USER_19": "",
"ARFIM_USER_20": "",
"ARFIM_USER_21": "",
"ARFIM_USER_22": "",
"ARFIM_USER_23": "",
"ARFIM_USER_24": "",
"INVOICE_AMT_OLD": "",
"DATE_BANK_PRINT": "",
"BANK_CONTROL_ID": "",
"AR_REMIT_TO": "",
"CURR_CODE": "",
"CURR_RATE": "",
"BC_RATE": "",
"INVOICE_LC_AMT": "",
"LC_AMT_PAID": "",
"LC_MEMO_AMT": "",
"LC_DISC_USED": "",
"LC_DISC_LOST": "",
"LC_CURRENT_BAL": "",
"CC_SECURITY_ID": "",
"CCVERIFY_MMYY": "",
"CC_AUTH_AMT": "",
"ORDER_TAKER": "",
"INVOICE_ORIG": "",
"DATE_LAST_EDI": "",
"E_MAIL": "",
"E_MAIL_DATE": "",
"CC_RTG_ID": "",
"LAST_TS_INV_NO": "",
"ORIG_INV_NUMBER": "",
"CHRG_ALLOW": "",
"CHRG_ALLOW_TYPE": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": "",
"LINES": {
"INV_LINE_NO": "",
"SO_LINE_NO": "",
"ACTION_DATE": "",
"ACTION_TYPE": "",
"PART_ID": "",
"PART_UM": "",
"SO_DESC": "",
"SO_UM": "",
"DWG_REV": "",
"ECN": "",
"CUST_PART_ID": "",
"STORES_CODE": "",
"COMPANY_ID": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"REFERENCE": "",
"BILL_OF_LADING": "",
"SHIP_TO_CUST": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"PRODUCT_LINE": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"SALES_COMM": "",
"COMMISSION_PCT": "",
"REV_ORDER_QTY": "",
"BALANCE_DUE": "",
"PRICE_CODE": "",
"SO_UNIT_COST": "",
"SO_UNIT_PRICE": "",
"ITEM_DISC_PCT": "",
"TAX_CODE": "",
"VAT_CODE": "",
"SHIPMENT_NO": "",
"SHIP_TYPE": "",
"QUANTITY": "",
"INV_QUANTITY": "",
"COST_AMT": "",
"AMOUNT": "",
"LINE_TAX_AMT": "",
"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_VAT": "",
"LINE_ORDER_DISC": "",
"ARFID_USER_1": "",
"ARFID_USER_2": "",
"REPORT_FLAG": "",
"RA_REASON": "",
"LC_LINE_AMT": "",
"LC_LINE_TAX": "",
"LC_LINE_DISC": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BASE_PRICE": "",
"PRICE_CONV": "",
"PRICE_UM": "",
"PROD_DISC_CODE1": "",
"PROD_DISC_CODE2": "",
"PROD_DISC_CODE3": "",
"PROD_DISC_AMT1": "",
"PROD_DISC_AMT2": "",
"PROD_DISC_AMT3": "",
"RR_PROCESSED": "",
"REVREC_ADJ": "",
"TAX_CALC_REQD": "",
"CHRG_ALLOW": "",
"CHRG_ALLOW_TYPE": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": ""
},
"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 AR Invoices which were found by the query:
200/OK
Returned JSON contains the AR Invoices which were found by the query:
[
{
"INVOICE_NUMBER": "",
"CUSTOMER_ID": "",
"GL_YEAR": "",
"GL_MONTH": "",
"BATCH_NUMBER": "",
"INVOICE_TYPE": "",
"INVOICE_DATE": "",
"SO_ID": "",
"SO_TYPE": "",
"ORDER_CLASS": "",
"SOLD_TO_CUST": "",
"SHIP_TO_CUST": "",
"CUST_PO_ID": "",
"REFERENCE": "",
"AR_COMPANY_ID": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"INVOICE_AMT": "",
"INVOICE_FRT_AMT": "",
"INVOICE_TAX_AMT": "",
"INVOICE_TAX_2": "",
"INVOICE_TAX_3": "",
"INVOICE_TAX_4": "",
"INVOICE_TAX_5": "",
"INVOICE_TAX_6": "",
"INVOICE_TAX_7": "",
"INVOICE_TAX_8": "",
"INVOICE_TAX_9": "",
"INVOICE_TAX_10": "",
"INVOICE_VAT": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"BANK_CODE": "",
"PAYMENT_TYPE": "",
"BANK_CARD_GUID": "",
"CARD_TYPE": "",
"BANK_CARD_ID": "",
"EXPIRATION": "",
"TRANS_TYPE": "",
"AUTH_CODE": "",
"CARD_NAME": "",
"CARD_PHONE_NO": "",
"TERMS_CODE": "",
"DISCOUNT_AMT": "",
"DISCOUNT_DATE": "",
"DUE_DATE": "",
"NEXT_PAY_DATE": "",
"NEXT_PAY_AMT": "",
"NEXT_PAY_DISC": "",
"REMARK": "",
"TOTAL_AMT_PAID": "",
"TOTAL_MEMO_AMT": "",
"TOTAL_DISC_USED": "",
"TOTAL_DISC_LOST": "",
"CURRENT_BALANCE": "",
"NO_HOLD_FLAG": "",
"INVOICE_STATUS": "",
"DATE_LAST_PRINT": "",
"REPRINT_FLAG": "",
"ARFIM_USER_1": "",
"ARFIM_USER_2": "",
"ARFIM_USER_3": "",
"ARFIM_USER_4": "",
"ARFIM_USER_5": "",
"ARFIM_USER_6": "",
"ARFIM_USER_7": "",
"ARFIM_USER_8": "",
"ARFIM_USER_9": "",
"ARFIM_USER_10": "",
"ARFIM_USER_11": "",
"ARFIM_USER_12": "",
"ARFIM_USER_13": "",
"ARFIM_USER_14": "",
"ARFIM_USER_15": "",
"ARFIM_USER_16": "",
"ARFIM_USER_17": "",
"ARFIM_USER_18": "",
"ARFIM_USER_19": "",
"ARFIM_USER_20": "",
"ARFIM_USER_21": "",
"ARFIM_USER_22": "",
"ARFIM_USER_23": "",
"ARFIM_USER_24": "",
"INVOICE_AMT_OLD": "",
"DATE_BANK_PRINT": "",
"BANK_CONTROL_ID": "",
"AR_REMIT_TO": "",
"CURR_CODE": "",
"CURR_RATE": "",
"BC_RATE": "",
"INVOICE_LC_AMT": "",
"LC_AMT_PAID": "",
"LC_MEMO_AMT": "",
"LC_DISC_USED": "",
"LC_DISC_LOST": "",
"LC_CURRENT_BAL": "",
"CC_SECURITY_ID": "",
"CCVERIFY_MMYY": "",
"CC_AUTH_AMT": "",
"ORDER_TAKER": "",
"INVOICE_ORIG": "",
"DATE_LAST_EDI": "",
"E_MAIL": "",
"E_MAIL_DATE": "",
"CC_RTG_ID": "",
"LAST_TS_INV_NO": "",
"ORIG_INV_NUMBER": "",
"CHRG_ALLOW": "",
"CHRG_ALLOW_TYPE": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": "",
"LINES": [
{
"INV_LINE_NO": "",
"SO_LINE_NO": "",
"ACTION_DATE": "",
"ACTION_TYPE": "",
"PART_ID": "",
"PART_UM": "",
"SO_DESC": "",
"SO_UM": "",
"DWG_REV": "",
"ECN": "",
"CUST_PART_ID": "",
"STORES_CODE": "",
"COMPANY_ID": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"REFERENCE": "",
"BILL_OF_LADING": "",
"SHIP_TO_CUST": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"PRODUCT_LINE": "",
"SALESMAN_ID": "",
"SALES_REGION": "",
"SALES_COMM": "",
"COMMISSION_PCT": "",
"REV_ORDER_QTY": "",
"BALANCE_DUE": "",
"PRICE_CODE": "",
"SO_UNIT_COST": "",
"SO_UNIT_PRICE": "",
"ITEM_DISC_PCT": "",
"TAX_CODE": "",
"VAT_CODE": "",
"SHIPMENT_NO": "",
"SHIP_TYPE": "",
"QUANTITY": "",
"INV_QUANTITY": "",
"COST_AMT": "",
"AMOUNT": "",
"LINE_TAX_AMT": "",
"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_VAT": "",
"LINE_ORDER_DISC": "",
"ARFID_USER_1": "",
"ARFID_USER_2": "",
"REPORT_FLAG": "",
"RA_REASON": "",
"LC_LINE_AMT": "",
"LC_LINE_TAX": "",
"LC_LINE_DISC": "",
"WEIGHT": "",
"NUMBER_CARTONS": "",
"BASE_PRICE": "",
"PRICE_CONV": "",
"PRICE_UM": "",
"PROD_DISC_CODE1": "",
"PROD_DISC_CODE2": "",
"PROD_DISC_CODE3": "",
"PROD_DISC_AMT1": "",
"PROD_DISC_AMT2": "",
"PROD_DISC_AMT3": "",
"RR_PROCESSED": "",
"REVREC_ADJ": "",
"TAX_CALC_REQD": "",
"CHRG_ALLOW": "",
"CHRG_ALLOW_TYPE": "",
"OPERATOR_ID": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": ""
}
]
}
]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 AR Invoice 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 AR Invoice query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}