DOCUMENTS

Get Sub Account List

Retrieve document sub-accounts. Use active to filter the results by activation status.

Class: documents

Method: get-sub-account-list

POST/documents/get-sub-account-list

Parameters

  • client_id*
  • akey*
  • active - this can be set to 1 to show only activated sub accounts, or 0 to show only deactivated sub accounts

JSON response

JSONResponse example
{
  "sub_accounts": [
    {
      "id": "1",
      "account_alias": "Operating Account",
      "confirmed": true,
      "active": true
    },
    {
      "id": "2",
      "account_alias": "Payroll Account",
      "confirmed": true,
      "active": true
    }
  ]
}

XML response

XMLResponse example
<?xml version="1.0" encoding="UTF-8"?>
<wmc-response status="1">
	<sub_accounts>
		<sub_account id='1'>
			<sub_account_id>1</sub_account_id>
			<account_alias>Operating Account</account_alias>
			<active>1</active>
			<confirmed>1</confirmed>
		</sub_account>
		<sub_account id='2'>
			<sub_account_id>2</sub_account_id>
			<account_alias>Payroll Account</account_alias>
			<active>1</active>
			<confirmed>1</confirmed>
		</sub_account>
	</sub_accounts>
</wmc-response>

Search documentation