04 vAPI_build_vendor_return

Build vendor return

Inputs:

Input Name	Required	Type	Max Length	Details
$arg_array	YES	ASSOC	--	Details follow:
$arg_array / company_id	YES	INT	--	references: company_master.company_id
$arg_array / vendor_returns_header_id	YES	INT	--	references: vendor_returns_header.vendor_returns_header_id
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ASSOC	Details follow:
$record / header	ASSOC	Details follow:
$record / header / vendor_code	STRING	references: vendor_returns_header.vendor_code
$record / header / company_id	INT	references: vendor_returns_header.company_id
$record / header / customer_code	STRING	references: vendor_returns_header.customer_code
$record / header / system_return_number	STRING	references: vendor_returns_header.system_return_number
$record / header / warehouse_code	STRING	references: vendor_returns_header.warehouse_code
$record / header / ra_number	STRING	references: vendor_returns_header.ra_number
$record / header / original_return_status	STRING	references: vendor_returns_header.original_return_status
$record / header / last_return_status	STRING	references: vendor_returns_header.last_return_status
$record / header / return_status	STRING	references: vendor_returns_header.return_status
$record / header / return_type	STRING	references: vendor_returns_header.return_type
$record / header / entered_by	INT	references: vendor_returns_header.entered_by
$record / header / entered_by_code	STRING	employee_master.employee_code associated with ID from entered_by
$record / header / modified_by	INT	references: vendor_returns_header.modified_by
$record / header / modified_by_code	STRING	employee_master.employee_code associated with ID from modified_by
$record / header / closed_by	INT	references: vendor_returns_header.closed_by
$record / header / closed_by_code	STRING	employee_master.employee_code associated with ID from closed_by
$record / header / freight_carrier	STRING	references: vendor_returns_header.freight_carrier
$record / header / freight_service	STRING	references: vendor_returns_header.freight_service
$record / header / freight_options	STRING	references: vendor_returns_header.freight_options
$record / header / freight_out	NUMERIC	references: vendor_returns_header.freight_out
$record / header / freight_out_actual	NUMERIC	references: vendor_returns_header.freight_out_actual
$record / header / freight_out_flag	STRING	references: vendor_returns_header.freight_out_flag
$record / header / reported_freight_weight	STRING	references: vendor_returns_header.reported_freight_weight
$record / header / freight_tracking_number	STRING	references: vendor_returns_header.freight_tracking_number
$record / header / restock_fee	NUMERIC	references: vendor_returns_header.restock_fee
$record / header / restock_percent	NUMERIC	references: vendor_returns_header.restock_percent
$record / header / billing_name	STRING	references: vendor_returns_header.billing_name
$record / header / billing_address_1	STRING	references: vendor_returns_header.billing_address_1
$record / header / billing_address_2	STRING	references: vendor_returns_header.billing_address_2
$record / header / billing_address_3	STRING	references: vendor_returns_header.billing_address_3
$record / header / billing_city	STRING	references: vendor_returns_header.billing_city
$record / header / billing_locality	STRING	references: vendor_returns_header.billing_locality
$record / header / billing_mailing_code	STRING	references: vendor_returns_header.billing_mailing_code
$record / header / billing_country	STRING	references: vendor_returns_header.billing_country
$record / header / billing_phone	STRING	references: vendor_returns_header.billing_phone
$record / header / billing_fax	STRING	references: vendor_returns_header.billing_fax
$record / header / billing_email	STRING	references: vendor_returns_header.billing_email
$record / header / shipping_name	STRING	references: vendor_returns_header.shipping_name
$record / header / shipping_address_1	STRING	references: vendor_returns_header.shipping_address_1
$record / header / shipping_address_2	STRING	references: vendor_returns_header.shipping_address_2
$record / header / shipping_address_3	STRING	references: vendor_returns_header.shipping_address_3
$record / header / shipping_city	STRING	references: vendor_returns_header.shipping_city
$record / header / shipping_locality	STRING	references: vendor_returns_header.shipping_locality
$record / header / shipping_mailing_code	STRING	references: vendor_returns_header.shipping_mailing_code
$record / header / shipping_country	STRING	references: vendor_returns_header.shipping_country
$record / header / comments	STRING	references: vendor_returns_header.comments
$record / header / shipping_instructions	STRING	references: vendor_returns_header.shipping_instructions
$record / header / date_entered	DATE	references: vendor_returns_header.date_entered
		Format: YYYY-MM-DD HH24:MI
$record / header / date_closed	DATE	references: vendor_returns_header.date_closed
		Format: YYYY-MM-DD HH24:MI
$record / header / date_shipped	DATE	references: vendor_returns_header.date_shipped
		Format: YYYY-MM-DD HH24:MI
$record / header / date_invoiced	DATE	references: vendor_returns_header.date_invoiced
		Format: YYYY-MM-DD HH24:MI
$record / header / pick_ticket_counter	INT	references: vendor_returns_header.pick_ticket_counter
$record / header / line_item_total	INT	Number of line items for the vendor return
$record / header / return_total	NUMERIC	Total of items, freight, restock_fee
$record / lines	ASSOC	Details follow:
$record / lines / line_number	INT	references: vendor_returns_line_items.line_number
$record / lines / item_code	STRING	references: vendor_returns_line_items.item_code
$record / lines / vendor_code	STRING	references: vendor_returns_line_items.vendor_code
$record / lines / description	STRING	references: vendor_returns_line_items.description
$record / lines / unit_of_measure	STRING	references: vendor_returns_line_items.unit_of_measure
$record / lines / warehouse_code	STRING	references: vendor_returns_line_items.warehouse_code
$record / lines / item_type	STRING	references: vendor_returns_line_items.item_type
$record / lines / quantity_returned	NUMERIC	references: vendor_returns_line_items.quantity_returned
$record / lines / taxable_flag	BOOLEAN	references: vendor_returns_line_items.taxable_flag
$record / lines / unit_price	NUMERIC	references: vendor_returns_line_items.unit_price
$record / lines / unit_cost	NUMERIC	references: vendor_returns_line_items.unit_cost
$record / lines / line_amount	STRING	Subtotal for the returned items in this line
$record / lines / line_disposition	STRING	references: vendor_returns_line_items.line_disposition
$record / lines / manufacturer	STRING	references: item_master.manufacturer
$record / lines / unit_weight	NUMERIC	references: item_master.unit_weight
$record / company_info	ASSOC	Output Generated By vAPI_get_company
$record / vendor_info	ASSOC	Output Generated By vAPI_get_vendor
$record / freight_info	ASSOC	Details follow:
$record / freight_info / freight_carrier_id	NUMERIC	references: freight_carrier.freight_carrier_id
$record / freight_info / company_id	NUMERIC	references: freight_carrier.company_id
$record / freight_info / description	STRING	references: freight_carrier.description
$record / freight_info / email_tracking_text	STRING	references: freight_carrier.email_tracking_text
$record / freight_info / ltl_carrier_flag	BOOLEAN	references: freight_carrier.ltl_carrier_flag
$record / freight_info / is_active_flag	BOOLEAN	references: freight_carrier.is_active_flag
$record / freight_info / sort_order	NUMERIC	references: freight_carrier.sort_order

Error Codes:

PGQUERY

Failed SQL query

Called API Functions:
customerAPI:vAPI_get_customer_statement
companyAPI:vAPI_get_company
vendorAPI:vAPI_get_vendor

Return to:
Notify_API Reference