Most recent edit on 2007-08-29 10:40:14 by LukeK
Additions:
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn't fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src and inv invoice #s are invalid |
Deletions:
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn't fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src & |
| inv invoice #s are invalid |
Edited on 2007-08-29 10:40:02 by LukeK
Additions:
19 vAPI_ar_batch_commit_to_history
| 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 / lock_owner |
YES |
STRING |
16 |
references: ar_batch.lock_owner |
| $dbconn |
YES |
DBHANDLE |
-- |
Database Connection |
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn't fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src & |
| inv invoice #s are invalid |
| NO_PERMISSION |
Permission denied to user |
| PGQUERY |
Failed SQL query |
| BATCH_LOCKED |
Requested Batch is locked by another user |
| BATCH_RUN_ERROR |
An error exists in the batch that will prevent it from running. $record is returned for this error code |
| INVALID_RECORD_TYPE |
Supplied Record Type is invalid |
Return to:
Deletions:
19 vAPI_ar_batch_commit_to_history
| Input Name |
Requred |
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 / lock_owner |
YES |
STRING |
16 |
references: ar_batch.lock_owner |
| $dbconn |
YES |
DBHANDLE |
— |
Database Connection |
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn’t fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src and inv invoice #s are invalid |
| PGQUERY |
Failed SQL query |
| BATCH_LOCKED |
Requested Batch is locked by another user |
| BATCH_RUN_ERROR |
An error exists in the batch that will prevent it from running. $record is returned for this error code |
| INVALID_RECORD_TYPE |
Supplied Record Type is invalid |
Return to:
Edited on 2007-08-23 13:39:16 by LukeK
Additions:
Return to:
AR_API Reference
Edited on 2007-08-23 13:38:50 by LukeK
Additions:
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn’t fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src and inv invoice #s are invalid |
Deletions:
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
|
|
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn’t fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src & |
inv invoice #s are invalid |
Edited on 2007-08-23 13:38:28 by LukeK
Additions:
| Output Name |
Type |
Details |
| $record |
ASSOC |
line_number is the key. Details follow: |
| $record / payment_reference |
STRING |
references: ar_batch.payment_reference |
| $record / amount |
NUMERIC |
references: ar_batch.amount |
| $record / record_type |
STRING |
references: ar_batch.record_type |
|
|
Possible Values: |
|
|
* CREDMEM |
|
|
* CREDREDIST |
|
|
* DEBMEM |
|
|
* DISCOUNT |
|
|
* DISTRIB |
|
|
* PAYMENT |
|
|
* WRITEOFF |
| $record / error_code |
STRING |
|
|
Possible Values: |
|
|
* PAYMENT_PARTIAL_DISTRIB: A PAYMENT record wasn’t fully distributed |
|
|
* INVALID_SRC_INVOICE: A src invoice # is invalid |
|
|
* INVALID_INV_INVOICE: A inv invoice # is invalid |
|
|
* INVALID_SRC_INV_INVOICE: Both src & |
inv invoice #s are invalid |
Deletions:
Unknown action; the action name must not contain special characters.
Oldest known version of this page was edited on 2007-08-23 13:38:19 by LukeK []
Page view:
19 vAPI_ar_batch_commit_to_history
Run a batch and commit to history.
If a problem is found (Error Code: BATCH_RUN_ERROR), the line_number information for the problem transaction is returned.
Inputs:
| Input Name |
Requred |
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 / lock_owner |
YES |
STRING |
16 |
references: ar_batch.lock_owner |
| $dbconn |
YES |
DBHANDLE |
— |
Database Connection |
Outputs:
Unknown action; the action name must not contain special characters.
Error Codes:
| PGQUERY |
Failed SQL query |
| BATCH_LOCKED |
Requested Batch is locked by another user |
| BATCH_RUN_ERROR |
An error exists in the batch that will prevent it from running. $record is returned for this error code |
| INVALID_RECORD_TYPE |
Supplied Record Type is invalid |
Called API Functions:
arAPI:vAPI_check_ar_batch_lock
arAPI:vAPI_check_ar_batch_for_run
arAPI_internal:vAPI_ar_batch_commit_payment_line
arAPI_internal:vAPI_ar_batch_commit_distrib_line
arAPI_internal:vAPI_ar_batch_commit_credmem_line
arAPI_internal:vAPI_ar_batch_commit_debmem_line
arAPI_internal:vAPI_ar_batch_commit_credredist_line
arAPI_internal:vAPI_ar_batch_commit_writeoff_line
arAPI_internal:vAPI_ar_batch_commit_discount_line