30 vAPI_batch_distrib_invoice_search

AR Invoice Lookup that includes CMs and DMs from the current Batch

Inputs:

Input Name	Required	Type	Max Length	Details
$arg_array / company_id	YES	INT	--	references: company_master.company_id
$arg_array / search_text	YES	TEXT	--	Special Searches:
				^ : Start of field match. Ex. ^John
				* : Show all ar_detail records with a balance
				=CM : Show all credit memos with a balance
$arg_array / batch_id	YES	STRING	32	references: ar_batch.batch_id
$arg_array / nonzero_only	NO	BOOL	--	Only display invoices with no pending balance
				Default: false
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ARRAY of ASSOCs	Details follow:
$record / system_order_number	STRING	references: ar_detail.system_order_number
$record / warehouse_code	STRING	references: ar_detail.warehouse_code
$record / suborder_counter	INT	references: ar_detail.suborder_counter
$record / customer_code	STRING	references: ar_detail.customer_code
$record / customer_terms_type	STRING	references: ar_detail.customer_terms_type
$record / customer_po	STRING	references: ar_detail.customer_po
$record / shipping_city	STRING	references: ar_detail.shipping_city
$record / shipping_locality	STRING	references: ar_detail.shipping_locality
$record / date_due	DATE	YYYY-MM-DD HH24:MI
		references: ar_detail.date_due
$record / date_ordered	DATE	YYYY-MM-DD HH24:MI
		references: ar_detail.date_ordered
$record / date_confirmed	DATE	YYYY-MM-DD HH24:MI
		references: ar_detail.date_confirmed
$record / item_total	MONETARY	references: ar_detail.item_total
$record / nonstock_item_total	MONETARY	references: ar_detail.nonstock_item_total
$record / direct_ship_item_total	MONETARY	references: ar_detail.direct_ship_item_total
$record / labor_total	MONETARY	references: ar_detail.labor_total
$record / freight_in	MONETARY	references: ar_detail.freight_in
$record / freight_out	MONETARY	references: ar_detail.freight_out
$record / prepaid_allow_freight	MONETARY	references: ar_detail.prepaid_allow_freight
$record / collect_freight	MONETARY	references: ar_detail.collect_freight
$record / misc_charges_total	MONETARY	references: ar_detail.misc_charges_total
$record / sales_tax_total	MONETARY	references: ar_detail.sales_tax_total
$record / order_total	MONETARY	references: ar_detail.order_total
$record / cost_total	MONETARY	references: ar_detail.cost_total
$record / nonstock_cost_total	MONETARY	references: ar_detail.nonstock_cost_total
$record / labor_cost_total	MONETARY	references: ar_detail.labor_cost_total
$record / tax_rate	NUMERIC 6.6	references: ar_detail.tax_rate
$record / sales_tax_percent	NUMERIC 6.4	references: ar_detail.sales_tax_percent
$record / state_tax	MONETARY	references: ar_detail.state_tax
$record / county_tax	MONETARY	references: ar_detail.county_tax
$record / city_tax	MONETARY	references: ar_detail.city_tax
$record / opt1_tax	MONETARY	references: ar_detail.opt1_tax
$record / opt2_tax	MONETARY	references: ar_detail.opt2_tax
$record / opt3_tax	MONETARY	references: ar_detail.opt3_tax
$record / amount_paid	MONETARY	references: ar_detail.amount_paid
$record / adjustment_total	MONETARY	references: ar_detail.adjustment_total
$record / check_date	DATE	YYYY-MM-DD
		references: ar_detail.check_date
$record / payment_verification	STRING	references: ar_detail.payment_verification
$record / date_invoiced	DATE	YYYY-MM-DD HH24:MI
		references: ar_detail.date_invoiced
$record / ar_amount_due	MONETARY	Total amount due on the invoice
$record / pending_payments	MONETARY	Total amount in AR batch payments that have not been processed
$record / pending_amount_due	STRING	Total amount due on the invoice including the pending payments

Error Codes:

PGQUERY

Failed SQL query

Called API Functions:
arAPI:vAPI_ar_simple_search

Return to:
AR_API Reference