16 vAPI_get_ar_batches
Get synopsis of all batches in ar_batch
Inputs:
| Input Name |
Required |
Type |
Max Length |
Details |
| $company_id |
YES |
INT |
-- |
references: company_master.company_id |
| $dbconn |
YES |
DBHANDLE |
-- |
Database Connection |
Outputs:
| Output Name |
Type |
Details |
| $record |
ARRAY of ASSOCs |
Row details follow: |
| $record / batch_id |
STRING |
references: ar_batch.batch_id |
| $record / date_batch_create |
DATE |
YYYY-MM-DD HH24:MI |
|
|
references: ar_batch.date_batch_created |
| $record / batch_line_count |
INT |
Number of lines in returned batch |
| $record / batch_locked |
BOOLEAN |
Whether the batch is locked in ar_batch_lock |
| $record / lock_owner |
STRING |
references: ar_batch_lock.lock_owner |
Error Codes:
Return to:
AR_API Reference
There are no comments on this page. [Add comment]