AP Invoice Entry, Query
Queries existing AP Invoices using the provided criteria and returns a list of found AP Invoices.
URL
/api/ap-invoice-entry-query
Request Method
POST
Expandable Program
AP Invoice/Memo Entry (APTIE)
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
{
"VENDOR_ID": "XYZCORP",
"INVOICE_TYPE": "IP",
"LINES": {
"PART_ID": "MOTOR003"
},
"AUTH_TOKEN": ""
}Full Request JSON
{
"VOUCHER_ID": "",
"VENDOR_ID": "",
"INVOICE_ID": "",
"INVOICE_TYPE": "",
"INVOICE_DATE": "",
"REFERENCE": "",
"PO_ID": "",
"PO_TYPE": "",
"PO_VENDOR": "",
"BUYER_ID": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"VAT_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": "",
"BANK_CODE": "",
"PAYMENT_TYPE": "",
"TERMS_CODE": "",
"DISCOUNT_AMT": "",
"DISCOUNT_DATE": "",
"DUE_DATE": "",
"ORDER_DISC_PCT": "",
"NEXT_PAY_DATE": "",
"NEXT_PAY_AMT": "",
"NEXT_PAY_DISC": "",
"PAY_CODE": "",
"LAST_CHECK_NO": "",
"DATE_LAST_CHECK": "",
"TOTAL_AMT_PAID": "",
"TOTAL_DISC_USED": "",
"TOTAL_DISC_LOST": "",
"CURRENT_BALANCE": "",
"INVOICE_STATUS": "",
"CURR_CODE": "",
"CURR_RATE": "",
"BC_RATE": "",
"INVOICE_LC_AMT": "",
"LC_AMT_PAID": "",
"LC_DISC_USED": "",
"LC_DISC_LOST": "",
"LC_CURRENT_BAL": "",
"GL_YEAR": "",
"GL_MONTH": "",
"EXCLUDE_1099": "",
"APFVO_USER_1": "",
"APFVO_USER_2": "",
"APFVO_USER_3": "",
"APFVO_USER_4": "",
"APFVO_USER_5": "",
"INV_PREV_PER": "",
"PREV_PER_PSTD": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": "",
"LINES": {
"SEQ_NUMBER": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"GL_YEAR": "",
"GL_MONTH": "",
"ACTION_DATE": "",
"ACTION_TYPE": "",
"BATCH_NUMBER": "",
"REFERENCE": "",
"DIST_TYPE": "",
"VENDOR_ID": "",
"INVOICE_ID": "",
"PO_ID": "",
"LINE_NUMBER": "",
"PART_ID": "",
"PO_UM": "",
"PART_UM": "",
"QUANTITY": "",
"INV_QUANTITY": "",
"AMOUNT": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"GL_FLAG": "",
"COMMENT_9": "",
"CURR_CODE": "",
"CURR_RATE": "",
"FC_AMOUNT": "",
"BC_RATE": "",
"BC_AMOUNT": "",
"APFVT_USER_1": "",
"APFVT_USER_2": "",
"APFVT_USER_3": "",
"APFVT_USER_4": "",
"APFVT_USER_5": "",
"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 AP Invoices which were found by the query:
200/OK
Returned JSON contains the AP Invoices which were found by the query:
[
{
"VOUCHER_ID": "",
"VENDOR_ID": "",
"INVOICE_ID": "",
"INVOICE_TYPE": "",
"INVOICE_DATE": "",
"REFERENCE": "",
"PO_ID": "",
"PO_TYPE": "",
"PO_VENDOR": "",
"BUYER_ID": "",
"FREIGHT_CODE": "",
"TAX_CODE": "",
"VAT_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": "",
"BANK_CODE": "",
"PAYMENT_TYPE": "",
"TERMS_CODE": "",
"DISCOUNT_AMT": "",
"DISCOUNT_DATE": "",
"DUE_DATE": "",
"ORDER_DISC_PCT": "",
"NEXT_PAY_DATE": "",
"NEXT_PAY_AMT": "",
"NEXT_PAY_DISC": "",
"PAY_CODE": "",
"LAST_CHECK_NO": "",
"DATE_LAST_CHECK": "",
"TOTAL_AMT_PAID": "",
"TOTAL_DISC_USED": "",
"TOTAL_DISC_LOST": "",
"CURRENT_BALANCE": "",
"INVOICE_STATUS": "",
"CURR_CODE": "",
"CURR_RATE": "",
"BC_RATE": "",
"INVOICE_LC_AMT": "",
"LC_AMT_PAID": "",
"LC_DISC_USED": "",
"LC_DISC_LOST": "",
"LC_CURRENT_BAL": "",
"GL_YEAR": "",
"GL_MONTH": "",
"EXCLUDE_1099": "",
"APFVO_USER_1": "",
"APFVO_USER_2": "",
"APFVO_USER_3": "",
"APFVO_USER_4": "",
"APFVO_USER_5": "",
"INV_PREV_PER": "",
"PREV_PER_PSTD": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"TIME_LAST_UPDT": "",
"DATE_LAST_UPDT": "",
"LINES": [
{
"SEQ_NUMBER": "",
"COMPANY_ID": "",
"DEPARTMENT": "",
"ACCOUNT": "",
"JOB_ID": "",
"OPER_CODE": "",
"GL_YEAR": "",
"GL_MONTH": "",
"ACTION_DATE": "",
"ACTION_TYPE": "",
"BATCH_NUMBER": "",
"REFERENCE": "",
"DIST_TYPE": "",
"VENDOR_ID": "",
"INVOICE_ID": "",
"PO_ID": "",
"LINE_NUMBER": "",
"PART_ID": "",
"PO_UM": "",
"PART_UM": "",
"QUANTITY": "",
"INV_QUANTITY": "",
"AMOUNT": "",
"PROGRAM_ID": "",
"REPORT_FLAG": "",
"GL_FLAG": "",
"COMMENT_9": "",
"CURR_CODE": "",
"CURR_RATE": "",
"FC_AMOUNT": "",
"BC_RATE": "",
"BC_AMOUNT": "",
"APFVT_USER_1": "",
"APFVT_USER_2": "",
"APFVT_USER_3": "",
"APFVT_USER_4": "",
"APFVT_USER_5": "",
"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 AP 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 AP Invoice query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}