Read Account
Retrieves the details of a Account object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/Accounts?filter=AccountName,eq,Robert Smith;Test CheckBox,eq,no&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Accounts?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Account?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Account?filter=Industry,eq,Apparel OR Recreation&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Account?filter=AccountID,eq,3422&key=xyzkey List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/Account?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/Accounts?filter=AccountName,eq,Robert Smith;Test CheckBox,eq,no&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/Accounts?filter=AccountName,eq,Robert Smith;Test CheckBox,eq,no&pageSize=10&key=xyzkey |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Accounts": {
"Account": [{
"AccountNumber": "105835",
"AccountID": "6548",
"ParentCompany": "",
"AccountName": "Test Account",
"Website": "www.abc.com",
"Telephone": "56412356",
"Fax": "5689746",
"TickerSymbol": "",
"OtherPhone": "56984663",
"Email": "[email protected]",
"Employees": "25",
"OtherEmail": "[email protected]",
"Ownership": "Ownership info",
"Rating": "none",
"Industry": "Recreation",
"SICCode": "10",
"Type": "Wholesale",
"AnnualRevenue": "65",
"SalesManager": "",
"AssignedToUser": "admin",
"CreatedTime": "01-24-2020 05:19:56",
"CreatedTimeUTC": "01-24-2020 15:01:35",
"ModifiedTime": "01-24-2020 05:19:56",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"TaxAuthority": "Indiana State",
"SalesArea": "United States",
"SalesPerson": "SalesRep2",
"AccountStatus": "",
"Priority": "--None--",
"PaymentMethod": "Cash",
"TermsAndConditions": "",
"Carrier": "Not Specified25",
"ShippingMethod": "???",
"DeliverFrom": "OAK",
"BackorderHandling": "--None--",
"SpecialHandling": "",
"BillingAddress": "1515 Clay Street",
"BillingSuburb": "",
"BillingCity": "Oakland",
"BillingPostcode": "94624",
"BillingState": "CA",
"BillingCountry": "United States",
"ShippingAddress": "1515 Clay Street",
"ShippingCity": "Oakland",
"ShippingPostcode": "94624",
"ShippingState": "CA",
"ShippingCountry": "United States",
"PriceBook": "Bargains",
"SpecialsPriceBook": "Retail - OAKS",
"Discount": "10",
"CreditLimitExpires": "01-24-2020",
"CreditLimit": "1000.00",
"TaxID": "45659",
"ResellerID": "8965",
"DefaultCurrency": "USD",
"Credits": "0",
"Description": "The Description Goes here.",
"AccountCustomFields": {
"CustomField": [{
"Name": "CustomField1",
"Value": "Custom info 1"
},
{
"Name": "CustomField2",
"Value": "Custom info 2"
},
{
"Name": "CustomDateField",
"Value": "yyyy-mm-dd"
}
]
}
}]
}
}
<Accounts>
<Account>
<AccountNumber>105835</AccountNumber>
<AccountID>6548</AccountID>
<ParentCompany></ParentCompany>
<AccountName>Test Account</AccountName>
<Website>www.abc.com</Website>
<Telephone>56412356</Telephone>
<Fax>5689746</Fax>
<TickerSymbol></TickerSymbol>
<OtherPhone>56984663</OtherPhone>
<Email>[email protected]</Email>
<Employees>25</Employees>
<OtherEmail>[email protected]</OtherEmail>
<Ownership>Ownership info</Ownership>
<Rating>none</Rating>
<Industry>Recreation</Industry>
<SICCode>10</SICCode>
<Type>Wholesale</Type>
<AnnualRevenue>65</AnnualRevenue>
<SalesManager></SalesManager>
<AssignedToUser>admin</AssignedToUser>
<CreatedTime>01-24-2020 05:19:56</CreatedTime>
<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
<ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<TaxAuthority>Indiana State</TaxAuthority>
<SalesArea>United States</SalesArea>
<SalesPerson>SalesRep2</SalesPerson>
<AccountStatus></AccountStatus>
<Priority>--None--</Priority>
<PaymentMethod>Cash</PaymentMethod>
<TermsAndConditions></TermsAndConditions>
<Carrier>Not Specified25</Carrier>
<ShippingMethod>???</ShippingMethod>
<DeliverFrom>OAK</DeliverFrom>
<BackorderHandling>--None--</BackorderHandling>
<SpecialHandling></SpecialHandling>
<BillingAddress>1515 Clay Street</BillingAddress>
<BillingSuburb></BillingSuburb>
<BillingCity>Oakland</BillingCity>
<BillingPostcode>94624</BillingPostcode>
<BillingState>CA</BillingState>
<BillingCountry>United States</BillingCountry>
<ShippingAddress>1515 Clay Street</ShippingAddress>
<ShippingCity>Oakland</ShippingCity>
<ShippingPostcode>94624</ShippingPostcode>
<ShippingState>CA</ShippingState>
<ShippingCountry>United States</ShippingCountry>
<PriceBook>Bargains</PriceBook>
<SpecialsPriceBook>Retail - OAKS</SpecialsPriceBook>
<Discount>10</Discount>
<CreditLimitExpires>01-24-2020</CreditLimitExpires>
<CreditLimit>1000.00</CreditLimit>
<TaxID>45659</TaxID>
<ResellerID>8965</ResellerID>
<DefaultCurrency>USD</DefaultCurrency>
<Credits>0</Credits>
<Description>The Description Goes here.</Description>
<AccountCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
<CustomField>
<Name>CustomDateFied</Name>
<Value>yyyy-mm-dd</Value>
</CustomField>
</AccountCustomFields>
</Account>
</Accounts>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Accounts">
<method name="GET">
<resource path="{AccountID/AccountNumber/AccountName/Email/TaxID/ResellerID}">
<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>
Updated about 21 hours ago