AOTG API: Debtor Lookup

Debtor Lookup

Get a list of customer.

API Method

Http Method: GET

Method: /api/public/v1/Lookup/DebtorLookup

Content-Type: application/json

Parameters: $filter, $top

Code Snippets

• Add header of "SOTC_AUTH", and assign value of AccessToken.

<?php

$request = new HttpRequest();
$request->setUrl('http://aotg.cloud:8080/api/Lookup/DebtorLookup');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Content-Type' => 'application/json',
  'SOTC_AUTH' => 'SAMs1a36d2-a139-e911-b8b3-000aa03t3d'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var client = new RestClient("http://aotg.cloud:8080/api/Lookup/DebtorLookup");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("SOTC_AUTH", "SAMs1a36d2-a139-e911-b8b3-000aa03t3d");
IRestResponse response = client.Execute(request);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://aotg.cloud:8080/api/Lookup/DebtorLookup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json",
    "SOTC_AUTH: SAMs1a36d2-a139-e911-b8b3-000aa03t3d",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://aotg.cloud:8080/api/Lookup/DebtorLookup"

payload = ""
headers = {
    'SOTC_AUTH': "SAMs1a36d2-a139-e911-b8b3-000aa03t3d",
    'Content-Type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Response

Response Successful HTTP Request

200 OK

Response Successful Body

• Result contains of 2 debtors.
  1st debtor has more data than the 2nd debtor, as the 1st debtor has 2 Branches.

[
    {
        "DataStructureVersion": 4,
        "AccNo": "300-A001",
        "CompanyName": "ABC CUSTOMER",
        "InvoiceAddress": {
            "Contact": "Mr.Tan",
            "Fax": "",
            "Phone": "02111373",
            "Address1": "1/2, PINE STREET,",
            "Address2": "CENTURY ROAD,",
            "Address3": "SELANGOR",
            "Address4": "50000 MALAYSIA"
        },
        "DeliverAddress": {
            "Contact": "Mr.Tan",
            "Fax": "",
            "Phone": "02111373",
            "Address1": "1/2, PINE STREET,",
            "Address2": "Delivery CENTURY ROAD,",
            "Address3": "SELANGOR",
            "Address4": "50000 MALAYSIA"
        },
        "SalesAgent": "",
        "CreditTerm": "C.O.D.",
        "IsActive": true,
        "CurrencyCode": "MYR",
        "CurrencySymbol": "RM",
        "IsInclusiveTax": false,
        "TaxCode": "",
        "DetailDiscount": "",
        "SalesExemptionNo": "",
        "SalesExemptionExpiryDate": null,
        "BranchList": [
            {
                "IsActive": true,
                "Code": "B00A",
                "Name": "BRANCH A",
                "Address1": null,
                "Address2": null,
                "Address3": null,
                "Address4": null,
                "PostCode": null,
                "Contact": "",
                "Phone": "",
                "Phone2": null,
                "Fax1": null,
                "Fax2": null,
                "SalesAgent": null,
                "Area": null,
                "EmailAddress": null,
                "RowState": 0
            },
            {
                "IsActive": true,
                "Code": "B00B",
                "Name": "BRANCH B",
                "Address1": null,
                "Address2": null,
                "Address3": null,
                "Address4": null,
                "PostCode": null,
                "Contact": "",
                "Phone": "",
                "Phone2": null,
                "Fax1": null,
                "Fax2": null,
                "SalesAgent": null,
                "Area": null,
                "EmailAddress": null,
                "RowState": 0
            }
        ],
        "TaxExemptionList": []
    },
    {
        "DataStructureVersion": 4,
        "AccNo": "300-A002",
        "CompanyName": "AutoCount On The Go",
        "InvoiceAddress": {
            "Contact": "Mr.Tan",
            "Fax": "",
            "Phone": "02111373",
            "Address1": "1/2, PINE STREET,",
            "Address2": "CENTURY ROAD,",
            "Address3": "SELANGOR",
            "Address4": "50000 MALAYSIA"
        },
        "DeliverAddress": {
            "Contact": "Mr.Tan",
            "Fax": "",
            "Phone": "02111373",
            "Address1": "1/2, PINE STREET,",
            "Address2": "Delivery CENTURY ROAD,",
            "Address3": "SELANGOR",
            "Address4": "50000 MALAYSIA"
        },
        "SalesAgent": "",
        "CreditTerm": "C.O.D.",
        "IsActive": true,
        "CurrencyCode": "MYR",
        "CurrencySymbol": "RM",
        "IsInclusiveTax": false,
        "TaxCode": "",
        "DetailDiscount": "",
        "SalesExemptionNo": "",
        "SalesExemptionExpiryDate": null,
        "BranchList": [],
        "TaxExemptionList": []
    }
]

Filter result

Use parameter of $filter or $top to filter the result of debtor.

Code Snippets

• Below sample uses 3 conditions to filter the result
  1. Debtor code that contains "300", and convert all characters to small letter.
  2. Company Name that contains "abc"
  3. Customer who is still active
• Result is then restricted to maximum of 15

http://aotg.cloud:8080/api/Lookup/DebtorLookup/api/Lookup/DebtorLookup?$filter=(substringof('300',tolower(AccNo)) or substringof('abc',tolower(CompanyName))) and IsActive eq true&$top=15

<?php

$request = new HttpRequest();
$request->setUrl('http://aotg.cloud:8080/api/Lookup/DebtorLookup');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  '$filter' => '%28substringof%28%27300%27,tolower%28AccNo%29%29%20or%20substringof%28%27abc%27,tolower%28CompanyName%29%29%29%20and%20IsActive%20eq%20true',
  '$top' => '15'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Content-Type' => 'application/json',
  'SOTC_AUTH' => 'SAMs1a36d2-a139-e911-b8b3-000aa03t3d'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var client = new RestClient("http://aotg.cloud:8080/api/Lookup/DebtorLookup?$filter=%28substringof%28%27300%27,tolower%28AccNo%29%29%20or%20substringof%28%27abc%27,tolower%28CompanyName%29%29%29%20and%20IsActive%20eq%20true&$top=15");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("SOTC_AUTH", "SAMs1a36d2-a139-e911-b8b3-000aa03t3d");
IRestResponse response = client.Execute(request);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://aotg.cloud:8080/api/Lookup/DebtorLookup?$filter=%28substringof%28%27300%27,tolower%28AccNo%29%29%20or%20substringof%28%27abc%27,tolower%28CompanyName%29%29%29%20and%20IsActive%20eq%20true&$top=15",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json",
    "SOTC_AUTH: SAMs1a36d2-a139-e911-b8b3-000aa03t3d",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://aotg.cloud:8080/api/Lookup/DebtorLookup"

querystring = {"$filter":"%28substringof%28%27300%27,tolower%28AccNo%29%29%20or%20substringof%28%27abc%27,tolower%28CompanyName%29%29%29%20and%20IsActive%20eq%20true","$top":"15"}

payload = ""
headers = {
    'SOTC_AUTH': "SAMs1a36d2-a139-e911-b8b3-000aa03t3d",
    'Content-Type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

See Also AOTG API

• Introduction to AOTG API
• Begin AutoCount Accounting Integration via AOTG API
• AOTG API Authenticate (Get AccessToken)

Debtor Get List of Debtor Create Debtor Update Debtor Delete Debtor Get Debtor

AR Invoice Get List of AR Invoice Create AR Invoice Create Batch AR Invoice Get AR Invoice

Item Create Stock Item

Create Create Cash Sale Create Cash Sale with Cash payment Create Cash Sale with Credit Card payment Create Cash Sale with Multi payment Create Cash Sale with no payment

Update Update Cash Sale Update Cash Sale with Cash payment Update Cash Sale with Credit Card payment Update Cash Sale with Multi payment Update Cash Sale with no payment

GL/AR/AP General Account Lookup (Find Account) Debtor Lookup (Find customer) Creditor Lookup (Find supplier)

General Payment Method Lookup

• AOTG API Result method's response status
• AOTG API Result Status is always '''InQueue'''
• AOTG API Error Message

Go to menu

Go to top

Resources For AutoCount Software Developers