api/APInvoiceEntry/Query (POST)
Queries existing AP Invoices using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found AP Invoices.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing AP Invoice query data.
Query Single AP Invoice Using Key Fields Example:
{
"VOUCHER_ID": "0002076114201"
}
Returns 1 AP Invoice if successful.
This is like 'Find' in Expandable.
Query Multiple AP Invoices Using Other Fields Example:
{
"INVOICE_TYPE": "IP",
"VENDOR_ID": "XYZCORP"
}
Returns 1 or more AP Invoices if successful.
This is like 'QBE' in Expandable.
Query Multiple AP Invoices Using QBE Conditional Notation Example:
{
"INVOICE_TAX_AMT": ""> 0",
"BUYER_ID": "IN 'DAL','PA'"
}
Returns 1 or more AP Invoices if successful.
This is like 'QBE' in Expandable.
Accepted AP Invoice Entry Fields:
APFVO_USER_1, APFVO_USER_2, APFVO_USER_3, APFVO_USER_4,
APFVO_USER_5, BANK_CODE, BC_RATE, BUYER_ID,
CREATED_BY, CURR_CODE, CURR_RATE, CURRENT_BALANCE,
DATE_CREATED, DATE_LAST_CHECK, DATE_LAST_UPDT, DATE_MODIFIED,
DISCOUNT_AMT, DISCOUNT_DATE, DUE_DATE, EXCLUDE_1099,
FREIGHT_CODE, GL_MONTH, GL_YEAR, INVOICE_AMT,
INVOICE_DATE, INVOICE_FRT_AMT, INVOICE_ID, INVOICE_LC_AMT,
INVOICE_STATUS, INVOICE_TAX_10, 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_AMT, INVOICE_TYPE,
INVOICE_VAT, LAST_CHECK_NO, LC_AMT_PAID, LC_CURRENT_BAL,
LC_DISC_LOST, LC_DISC_USED, MODIFIED_BY, NEXT_PAY_AMT,
NEXT_PAY_DATE, NEXT_PAY_DISC, ORDER_DISC_PCT, PAY_CODE,
PAYMENT_TYPE, PO_ID, PO_TYPE, PO_VENDOR,
REFERENCE, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT,
TOTAL_AMT_PAID, TOTAL_DISC_LOST, TOTAL_DISC_USED, VAT_CODE,
VENDOR_ID, VOUCHER_ID |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found AP Invoices.
Error:
400/Request JSON is invalid.
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 AP Invoice Entry Fields:
APFVO_USER_1, APFVO_USER_2, APFVO_USER_3, APFVO_USER_4, APFVO_USER_5, BANK_CODE, BC_RATE, BUYER_ID, CREATED_BY, CURR_CODE, CURR_RATE, CURRENT_BALANCE, DATE_CREATED, DATE_LAST_CHECK, DATE_LAST_UPDT, DATE_MODIFIED, DISCOUNT_AMT, DISCOUNT_DATE, DUE_DATE, EXCLUDE_1099, FREIGHT_CODE, GL_MONTH, GL_YEAR, INVOICE_AMT, INVOICE_DATE, INVOICE_FRT_AMT, INVOICE_ID, INVOICE_LC_AMT, INVOICE_STATUS, INVOICE_TAX_10, 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_AMT, INVOICE_TYPE, INVOICE_VAT, LAST_CHECK_NO, LC_AMT_PAID, LC_CURRENT_BAL, LC_DISC_LOST, LC_DISC_USED, MODIFIED_BY, NEXT_PAY_AMT, NEXT_PAY_DATE, NEXT_PAY_DISC, ORDER_DISC_PCT, PAY_CODE, PAYMENT_TYPE, PO_ID, PO_TYPE, PO_VENDOR, REFERENCE, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, TOTAL_AMT_PAID, TOTAL_DISC_LOST, TOTAL_DISC_USED, VAT_CODE, VENDOR_ID, VOUCHER_ID
Returned AP Invoice Entry Detail Fields:
ACCOUNT, ACTION_DATE, ACTION_TYPE, AMOUNT, APFVT_USER_1, APFVT_USER_2, APFVT_USER_3, APFVT_USER_4, APFVT_USER_5, BATCH_NUMBER, BC_AMOUNT, BC_RATE, COMMENT_9, COMPANY_ID, CREATED_BY, CURR_CODE, CURR_RATE, DATE_CREATED, DATE_LAST_UPDT, DATE_MODIFIED, DEPARTMENT, DIST_TYPE, FC_AMOUNT, GL_FLAG, GL_MONTH, GL_YEAR, INV_QUANTITY, INVOICE_ID, JOB_ID, LINE_NUMBER, MODIFIED_BY, OPER_CODE, OPERATOR_ID, PART_ID, PART_UM, PO_ID, PO_UM, PROGRAM_ID, QUANTITY, REFERENCE, REPORT_FLAG, SEQ_NUMBER, TIME_LAST_UPDT, VENDOR_ID, VOUCHER_ID