Skip to main content
Aria Knowledge Central

get_all_actions_by_receipt_id_m Sample Call and Response

This example shows a call that retrieves the system actions associated with one specific client receipt identifier and account combination, based on the plsql_m_r73.yml release definition for get_all_actions_by_receipt_id_m.

This example includes every required field, and it shows the repeatable action array with two representative entries. It does not cover every optional qualifier label and value pair the returned action records can carry.

Sample call

{
  "rest_call": "get_all_actions_by_receipt_id_m",
  "output_format": "json",
  "client_no": 105,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "acct_no": 300224981,
  "client_receipt_id": "RCPT-2026-0417-001"
}

The rest_call and output_format fields are not part of the method’s documented arguments; the REST gateway adds them to every call to identify the method being invoked and to request a JSON response. The method requires an account identifier, so this example supplies the Aria-assigned acct_no rather than the alternative client-defined client_acct_id. It also requires the client-defined client_receipt_id that was passed on the original call whose downstream actions you want to trace. Unlike get_all_acct_receipt_ids_m, which lists the receipt identifiers themselves, this method looks up what actually happened as a result of one particular receipt-and-account combination.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "receipt_action": [
    {
      "action_type_id": 14,
      "action_type_label": "Plan Assignment",
      "action_type_desc": "A plan was assigned to the account.",
      "action_rec_id_label": "Plan No.",
      "action_rec_id_val": "88452201",
      "action_date": "20260417093012",
      "action_user": "jsmith",
      "action_qualifier_1_label": "Plan Units",
      "action_qualifier_1_val": "1"
    },
    {
      "action_type_id": 22,
      "action_type_label": "Payment Method Update",
      "action_type_desc": "The account's payment method was updated.",
      "action_rec_id_label": "Payment Method No.",
      "action_rec_id_val": "5560012",
      "action_date": "20260417093045",
      "action_user": "jsmith"
    }
  ]
}

An error_code of zero with an error_msg of “OK” indicates that Aria located the receipt-and-account combination and returned its actions successfully. The receipt_action field is an array of action records; this example shows two entries to illustrate the repeatable structure, but a single receipt could be linked to more actions than shown. Each entry identifies the action type, the object the action was performed on (labeled by action_rec_id_label with its value in action_rec_id_val), when it occurred, and which user invoked it. The first entry also includes one qualifier pair (action_qualifier_1_label and action_qualifier_1_val), which supplies related detail specific to that action type; the method supports up to four such qualifier pairs, and this example leaves the remaining three out of both entries since they do not apply here. This example also leaves out the nonpublic error_details field, which the method returns internally but which does not represent client-facing information.

TOP
  • Was this article helpful?