10 vAPI_add_ar_batch_writeoff

Add WRITEOFF type record to ar_batch

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 / batch_id	YES	STRING	32	references: ar_batch.batch_id
$arg_array / pay_line_number	YES	INT	--	references: ar_batch.pay_line_number
$arg_array / amount	YES	NUMERIC	15.2(+)	references: ar_batch.amount
$arg_array / write_off_code	YES	STRING	4	references: write_off_gl_accounts.write_off_code
$arg_array / inv_system_order_number	YES	STRING	32	references: ar_detail.system_order_number
$arg_array / inv_warehouse_code	YES	STRING	8	references: ar_detail.warehouse_code
$arg_array / inv_suborder_counter	YES	INT	--	references: ar_detail.suborder_counter
$arg_array / description	YES	TEXT	--	references: ar_batch.description
$arg_array / batch_created_by	YES	STRING	16	references: ar_batch.batch_created_by
				Usually is the employee code of the user
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ASSOC	Details follow:
$record / company_id	INT	references: ar_batch.company_id
$record / batch_id	STRING	references: ar_batch.batch_id
$record / line_number	INT	references: ar_batch.line_number
$record / pay_line_number	INT	references: ar_batch.pay_line_number
$record / customer_code	STRING	references: ar_batch.customer_code
$record / payment_type	STRING	references: ar_batch.payment_type
$record / payment_reference	STRING	references: ar_batch.payment_reference
$record / record_type	STRING	references: ar_batch.record_type
$record / amount	MONETARY	references: ar_batch.amount
$record / write_off_code	STRING	references: ar_batch.write_off_code
$record / src_system_order_number	STRING	references: ar_batch.src_system_order_number
$record / src_warehouse_code	STRING	references: ar_batch.src_warehouse_code
$record / src_suborder_counter	INT	references: ar_batch.src_suborder_counter
$record / inv_system_order_number	STRING	references: ar_batch.inv_system_order_number
$record / inv_warehouse_code	STRING	references: ar_batch.inv_warehouse_code
$record / inv_suborder_counter	INT	references: ar_batch.inv_suborder_counter
$record / description	TEXT	references: ar_batch.description
$record / batch_created_by	STRING	references: ar_batch.batch_created_by
$record / date_batch_created	DATE	YYYY-MM-DD HH24:MI
		references: ar_batch.date_batch_created
$record / auto_pay_flag	BOOLEAN	references: ar_batch.auto_pay_flag

Error Codes:

NO_PERMISSION	Permission denied to user
PGQUERY	Failed SQL query
BATCH_LOCKED	AR Batch is Locked
INVALID_INVOICE	Supplied Invoice # info is invalid
INVALID_WRITEOFF_CODE	Supplied Write-Off code is invalid

Called API Functions:
arAPI:vAPI_check_ar_batch_lock


Return to:
AR_API Reference