Home > Aria6 User Documentation > Aria6 core api > get_daily_batch_status


Returns a string representing the current status of the Net Terms/Statement Status Mgr batch job for the given client and date.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png batch_date string 10 The (virtual) system date to be examined for current operational status of its daily batch jobs.
  include_all_batches string 2 Returns all batch process statuses for the day. If include_all_batch is true and batch_id is given, only supplied batch_id details will be returned.
  batch_process_id string 2 Valid Aria-supported batch ID.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
batch_process_detail hash  
  batch_process_id string Aria-supported batch process ID associated to the client.
  batch_process_name string Name associated with the batch process ID.
  batch_process_status  string

An upper-case string, from a list of allowable values, that represents current status of the daily batch process for the given input client, batch date, and batch ID.

Allowable values for status:

Values Description
NEW Job is queued to run but has not yet begun running.
RUNNING, NO ERRORS Job is currently running.
COMPLETED NO ERRORS Job has run to completion and encountered no errors.
PROCESSES DIED BEFORE COMPLETION One or more job processes died before completion.
FAILED WITH FATAL ERROR Job has ceased to run due to encountering a fatal error.
COMPLETED, SOME ERRORS Job has run to completion but encountered one or more non-fatal errors.
DID NOT RUN DUE TO DEPENDENCY ERROR Job was unsuccessful due to failure of related process.
SUSPENDED Job request was suspended. 
Last modified


This page has no custom tags.


This page has no classifications.