Skip to main content
Aria Knowledge Central

add_coa_m Sample Call and Response

This example shows a client creating a new, client-defined Chart of Accounts entry that financial applications can reference later. It is based on the add_coa_m method as defined in methods_m_r73.yml, Admin Tools API.

This example includes every required field plus the one optional field that gives the entry a meaningful description. It does not attempt to show every Chart of Accounts entry a client might create, only one representative call.

Sample call

{
  "rest_call": "add_coa_m",
  "output_format": "json",
  "client_no": 10023,
  "auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "coa_code": "REV-1000",
  "coa_description": "Subscription Revenue - Enterprise Plans"
}

The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call, and coa_code is the required, client-defined code that Aria stores and returns to financial applications. The optional coa_description field is included here to give the entry a human-readable label, but you may omit it if the code alone is sufficient for your integration.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "coa": {
    "coa_id": 4501,
    "coa_code": "REV-1000",
    "coa_description": "Subscription Revenue - Enterprise Plans"
  }
}

An error_code of zero, paired with an error_msg of “OK,” indicates that Aria created the entry successfully. The coa object represents a single Chart of Accounts entry, the one just created, and is not a repeatable array, because each call to add_coa_m creates exactly one entry. The coa_id field is the numeric identifier Aria assigns to the new entry, while coa_code and coa_description echo back the values supplied in the call. This example leaves out nothing else from the method’s return structure; the full response consists only of the error indicators and the single coa object shown here.

TOP
  • Was this article helpful?