Read Account Balance

Retrieves the account balance of a Account object that has been previously created.

Parameters

Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/AccountBalance will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/AccountBalance
accountId:string
In this parameter unique identification of account need to be passed to fetch related details.For eg. Account ID, If Account Balance for Account id 3442 needs to be fetch, then the url will be
https://{your_company}.agiliron.net/agiliron/api-40.php/AccountBalance/3422
Header Params
Accept: string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
	"Accounts": {
		"Account": [{
			"AccountID": "151346",
			"AccountBalance": "200.00"
		}]
	}
}
<Accounts>
    <Account>
        <AccountID>151346</AccountID>
        <AccountBalance>200.00</ParentCompany>
    </Account>
</Accounts>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="AccountBalance"> 
       <method name="GET">
	   <resource path="{AccountID}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>	
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

© Copyright 2022 Agiliron - All Rights Reserved.