Skip to main content
Aria Knowledge Central

get_writeoff_details_m Sample Call and Response

This example retrieves the details of a write-off transaction applied to an account, based on the method definition in plsql_m_r73.yml.

This example includes every required field the method accepts. It does not cover the client-defined account identifier alternative.

Sample call

{
  "rest_call": "get_writeoff_details_m",
  "output_format": "json",
  "client_no": 10023,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "acct_no": 3300481,
  "writeoff_transaction_id": 78832201
}

The envelope fields rest_call and output_format are added by the REST layer and are not part of the method’s own documented arguments. The account is identified with acct_no rather than its alternative, client_acct_id. This example leaves out do_logging_ind, mp_instance_id, and client_mp_instance_id, all of which are marked nonpublic and for internal use only.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "error_details": "",
  "writeoff_detail": [
    {
      "invoice_no": 8820044,
      "invoice_bill_date": "2026-05-01",
      "invoice_transaction_id": 78832201,
      "original_transaction_amount": 49.99,
      "writeoff_transaction_amount": 49.99,
      "writeoff_transaction_start_date": "2026-05-01",
      "writeoff_transaction_end_date": "2026-05-31"
    },
    {
      "invoice_no": 8820044,
      "invoice_bill_date": "2026-05-01",
      "invoice_transaction_id": 78832202,
      "original_transaction_amount": 9.99,
      "writeoff_transaction_amount": 5.0,
      "writeoff_transaction_start_date": "2026-05-01",
      "writeoff_transaction_end_date": "2026-05-31"
    }
  ]
}

An error_code of zero and an error_msg of OK indicate that the call succeeded. The writeoff_detail array holds one entry per invoice line item affected by the write-off transaction; this example shows two entries, a fully written-off line item and a partially written-off line item, and a real write-off could affect more line items than shown.

TOP
  • Was this article helpful?