Get Location Listing

Request

GET:/{accountBookId}/location/listing

Request Parameters

Parameter	Description	Type
page	Page index of returned records. Each page contains at most 100 records. Using a page index beyond the number of available pages will result in empty result.	number	required
activeOnly	Active only flag. When field value is "true", only active sales agents will be included in the query.	boolean

Example Request URL:

Parameters:
accountBookId = 1
page = 1
activeOnly = true

URL:
GET: https://accounting-api.autocountcloud.com/1/location/listing?activeOnly=true&page=1

---

Response

Success Response

Status Code: 200

Response Body

Field	Description	Type
data	Response data.	array[Location Listing View Model]
totalCount	Number of records retrieved.	number

Example Success Response Body

{
    "data": [
        {
            "location": "HQ",
            "description": "Headquarters",
            "desc2": "",
            "address": "Jalan Perkasa Satu, Taman Maluri, Kuala Lumpur, Wilayah Persekutuan",
            "postCode": "55100",
            "phone1": "03-9285 5233",
            "phone2": "",
            "fax1": "",
            "fax2": "",
            "contact": "Mr Han",
            "note": "",
            "isActive": true,
            "areaCode": "KUL",
            "isDefault": true
        },
        {
            "location": "Warehouse",
            "description": "Stock warehouse",
            "desc2": "",
            "address": "No. 94 Lrg Maarof Taman Bangsar, Kuala Lumpur, Wilayah Persekutuan\n",
            "postCode": "59000",
            "phone1": "03- 2282 6195",
            "phone2": "",
            "fax1": "",
            "fax2": "",
            "contact": "Mr Po",
            "note": "",
            "isActive": true,
            "areaCode": "KUL",
            "isDefault": false
        }
    ],
    "totalCount": 2
}

Error Response

Response Body

object: Error Response Model

Example Error Response Body

{
  "statusCode": 401,
  "message": "401 Unauthorized."
}