update_cm_m Sample Call and Response
This example shows a call that saves additional qualifier details on an existing credit memo, based on the plsql_m_r73.yml release definition for update_cm_m.
This example includes every required field plus a two-entry qualifier array that adds supplemental information to the credit memo. It does not cover the qualifier-removal directive values, which apply only when you want to remove previously added qualifiers.
Sample call
{
"rest_call": "update_cm_m",
"output_format": "json",
"client_no": 105,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 300224981,
"cm_no": 5502231,
"cm_qualifiers_update": [
{
"cm_qualifier_name": "dispute_reason",
"cm_qualifier_value": "Duplicate charge"
},
{
"cm_qualifier_name": "case_number",
"cm_qualifier_value": "CASE-88213"
}
]
}
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. This method requires two alternative-field pairs: the account, resolved here with the Aria-assigned acct_no rather than client_acct_id, and the credit memo itself, resolved here with the Aria-assigned cm_no rather than client_cm_seq_id. The optional cm_qualifiers_update field is an array of qualifier name-and-value pairs to associate with the credit memo; this example shows two entries, a dispute reason and a case number, to illustrate the repeatable structure. Neither entry specifies cm_qualifier_directive, so each defaults to a value of one, which adds the qualifier to the credit memo. Other directive values exist: two removes a specific qualifier name-and-value pair while leaving other values under that name untouched, and three removes every qualifier entry under a given name regardless of value.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero with an error_msg of “OK” indicates that Aria saved the credit memo qualifiers successfully. This method’s returns: block defines only the two error-indicator fields, so no additional output fields or arrays are omitted from this example.