AR Customer
|
URL |
Verbs |
Function |
|---|---|---|
|
Customer |
GET |
Query a list of all customers |
|
Customer |
POST |
Create a new customer |
|
Customer/<code> |
GET |
Query a single customer |
|
Customer/<code> |
POST |
Update an existing customer |
|
Customer/<code> |
DELETE |
Delete an existing Customer |
Supported modifiers
|
Query String |
Definition |
Sample
|
Available
|
|---|---|---|---|
| modifiedSince | Return Customers modified since a particular date and time | modifiedSince=2013-02-28T16:45:00 | |
| isActive | Return a list of Customers that are Active | isActive=true | |
| emailAddress | Return a list of Customers for a particular email address | emailAddress=enquiries@domain.com | |
| treeName and treeBranch | Return a list of Customers assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | |
| includeWebUsers | Return the Web Users linked to the Customer | includeWebUsers=true | Post 2018.3 |
| respectAdvancedSecurityForUser | Return only Customers that are accessible to the nominated User based on Advanced Security | respectAdvancedSecurityForUser=Susan Smith | 2020.3 |
Security Linked Menu
|
Menu Item
|
Located
|
|---|---|
| Customer Maintenance | Data Entry / Accounts Receivable |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<Customer>
<Code>1000</Code>
<Alpha>KANGAN</Alpha>
<Name>Kangan Education Unit</Name>
<OidString>2550.21</OidString>
<Edition>151</Edition>
<Address>
<Contact>Lisa Stanley</Contact>
<Address1>50 Glengarry Ave</Address1>
<Address2/>
<Address3/>
<Suburb>Burwood</Suburb>
<Postcode>3125</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(03) 8425 1213</PhoneBH>
<PhoneAH/>
<Fax>(03) 8425 1255</Fax>
<Email/>
<Web/>
<Mobile>0413 225 336</Mobile>
</Address>
<BankAccount>
<AccountNo>4378293112</AccountNo>
<Branch>9633696</Branch>
<BranchNo/>
<Name>063333</Name>
<No/>
<Suffix/>
<FullBankAccount>4378293112</FullBankAccount>
</BankAccount>
<ChequeName/>
<Contact>Lisa Stanley</Contact>
<CreateDate>2007-02-18</CreateDate>
<CreditLimit>100000.00</CreditLimit>
<CreditLimitOverdue1Plus>2000.00</CreditLimitOverdue1Plus>
<CreditLimitOverdue2Plus>0.00</CreditLimitOverdue2Plus>
<CreditLimitOverdue3Plus>0.00</CreditLimitOverdue3Plus>
<CreditLimitOverdue4Plus>0.00</CreditLimitOverdue4Plus>
<DiscountPending>0</DiscountPending>
<EntryTimeStamp>2003-02-18T08:57:59</EntryTimeStamp>
<EntryUser/>
<InvoiceDiscount>0.00</InvoiceDiscount>
<InvoiceRecipientAddress/>
<IsCheckingCredit>false</IsCheckingCredit>
<IsChild>false</IsChild>
<IsCreditAllowed>true</IsCreditAllowed>
<ModifiedTimeStamp>T00:00:00</ModifiedTimeStamp>
<ModifiedUser/>
<BalanceType>Open Item</BalanceType>
<Branch>03</Branch>
<CBAnalysis>ARRC</CBAnalysis>
<Calendar>JUN</Calendar>
<Currency>AUD</Currency>
<DefaultINCreditNoteType>AR Credit</DefaultINCreditNoteType>
<DefaultINInvoiceType>Issue</DefaultINInvoiceType>
<DefaultPaymentTerm>30 Days from Invoice Date</DefaultPaymentTerm>
<DefaultPriceLevel>RETAIL</DefaultPriceLevel>
<InvoiceDeliveryMethod>Print</InvoiceDeliveryMethod>
<ReceiptDeliveryMethod>Print</ReceiptDeliveryMethod>
<ReceiptType>Cheque</ReceiptType>
<RefundCBAnalysis/>
<RefundMethod/>
<SOBackorderPriority>Priority 5</SOBackorderPriority>
<SalesPerson>SAMPSS</SalesPerson>
<StatementDeliveryMethod>Print</StatementDeliveryMethod>
<Status>Active</Status>
<TaxCode>GST 10%</TaxCode>
<TaxMethod>Inclusive</TaxMethod>
<Notes>About Kangan
Kangan is:
a multi-discipline institute, providing industry-designed, nationally-accredited vocational training for a broad range of occupations.
major training provider for the automotive, aerospace and polymer industries.
largest providers of trainee/apprenticeship training and VET in Schools education.
host to 24,000 students across our six campuses in north-west, including a large international student population.
highly-regarded nationally and internationally for our quality training, and curriculum research and development services.
committed to social justice, as a major provider of education , and educational services within corrections settings.
an acknowledged leader in education, being named Training Provider of the Year in the 2001 Training Awards, and a Finalist in the 2001 Business Excellence Awards.
</Notes>
<PayeeRef1/>
<PayeeRef2/>
<PayeeRef3/>
<IsOrderNumberRequired>false</IsOrderNumberRequired>
<IsOrderNumberUnique>false</IsOrderNumberUnique>
<Balances>
<Current>500.01</Current>
<Overdue1>2805.67</Overdue1>
<Overdue2>379.25</Overdue2>
<Overdue3>0.00</Overdue3>
<Overdue4Plus>0.00</Overdue4Plus>
<Future>20579.50</Future>
<Hold>0.00</Hold>
</Balances>
<SalesOrderTotal>41917.45</SalesOrderTotal>
<DeliveryAddresses collection='true' count='2'>
<DeliveryAddress>
<AddressNumber>1</AddressNumber>
<IsPrimaryAddress>false</IsPrimaryAddress>
<IsActive>true</IsActive>
<RunNumber>10</RunNumber>
<DropSequence>20</DropSequence>
<Instructions/>
<Contact>Des Stanley</Contact>
<Address1>(Rear Door) via lane</Address1>
<Address2>Lot 2, Main Hwy</Address2>
<Address3>MacGregor</Address3>
<Suburb/>
<Postcode>3125</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(03) 8425 1213</PhoneBH>
<PhoneAH/>
<Fax/>
<Email/>
<Web/>
<Mobile/>
</DeliveryAddress>
<DeliveryAddress>
<AddressNumber>2</AddressNumber>
<IsPrimaryAddress>false</IsPrimaryAddress>
<IsActive>true</IsActive>
<RunNumber>10</RunNumber>
<DropSequence>30</DropSequence>
<Instructions/>
<Contact>Stan Jones</Contact>
<Address1>12 Smith Street</Address1>
<Address2/>
<Address3>MacGregor</Address3>
<Suburb/>
<Postcode>3125</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(03) 8452 2256</PhoneBH>
<PhoneAH/>
<Fax/>
<Email/>
<Web/>
<Mobile/>
</DeliveryAddress>
</DeliveryAddresses>
<WebUsers collection='true' count='1'>
<ECWebUser>
<Edition>10</Edition>
<OidString>3780.2</OidString>
<Name>kangan-1</Name>
<Login>kangan</Login>
<EmailAddress/>
<IsActive>true</IsActive>
<SecurityGroup>Account Customers AUS</SecurityGroup>
</ECWebUser>
</WebUsers>
<UserDefinedFields collection='true' count='2'>
<UserDefinedField>
<Name>Review Date</Name>
<Type>Date</Type>
<Value>2005-04-15</Value>
</UserDefinedField>
<UserDefinedField>
<Name>UBD Ref</Name>
<Type>String</Type>
<Value>30 A5</Value>
</UserDefinedField>
</UserDefinedFields>
<Trees collection='true' count='2'>
<Tree>
<Name>Customer Type-AUS</Name>
<IsMandatory>false</IsMandatory>
<Value>Other Customer Type</Value>
<Path>Other Customer Type</Path>
<ShortCode>OTHER</ShortCode>
</Tree>
<Tree>
<Name>Region-AUS</Name>
<IsMandatory>false</IsMandatory>
<Value>Victoria</Value>
<Path>Australia\Victoria</Path>
<ShortCode>VIC</ShortCode>
</Tree>
</Trees>
</Customer>