Skip to main content
Aria Knowledge Central

record_out_going_payment_m Sample Call and Response

This example shows a call that records a remittance payment against a net terms account, based on the record_out_going_payment_m method defined in plsql_m_r73.yml.

This example includes every required field and a representative set of commonly used optional fields, not every field the method accepts.

Sample call

{
  "rest_call": "record_out_going_payment_m",
  "output_format": "json",
  "client_no": 66123,
  "auth_key": "sample-auth-key-not-real-000111",
  "account_no": 3038219,
  "payment_amount": 1500.00,
  "reference_code": "REMIT-58821",
  "comments": "Remittance received by wire transfer to cover the outstanding June invoice balance."
}

The account_no field and the client_acct_id field are alternatives to each other; this example supplies the Aria-assigned account_no rather than the client-defined client_acct_id, since account_no is the identifier Aria assigns and returns for an account. The auth_key and output_format fields sit outside the method's own documented arguments; auth_key authenticates the caller, and output_format, together with rest_call, forms the envelope that the REST gateway adds to every call, requesting a JSON response.

Sample response

{
  "transaction_id": 88452019,
  "error_code": 0,
  "error_msg": "OK"
}

An error_code value of 0 and an error_msg value of "OK" indicate that Aria recorded the remittance successfully. The transaction_id field returns the unique identifier Aria assigned to this newly recorded transaction. This example does not include the error_details field, since that field is for internal use and does not appear in a client-facing response.

TOP
  • Was this article helpful?