Get Debtor Listing

Request

GET:/{accountBookId}/debtor/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 creditors will be included in the query.	boolean
field	List of fields to be included in records returned by query. Field names can be found here. (case-insensitive)	array[string]

Example Request URL:

Example: Get listing of active debtors with additional "creditTerm" and "address" fields in listing records.

Parameters:
accountBookId = 1
page = 1
activeOnly = true
field = ["creditTerm", "address"]

URL:
GET: https://accounting-api.autocountcloud.com/1/debtor/listing?activeOnly=true&field=creditTerm&field=address&page=1

---

Response

Success Response

Status Code: 200

Response Body

Field	Description	Type
data	Response data.	array[Debtor Data Model]
totalCount	Number of records retrieved.	number

Example Success Response Body

 {
    "data": [
        {
            "AccNo": "300-0001",
            "CompanyName": "Foreign Customer A",
            "CurrencyCode": "USD",
            "CreditTerm": "C.O.D.",
            "Address": "3040 Limer Street, Atlanta, Georgia"
        },
        {
            "AccNo": "300-D001",
            "CompanyName": "Customer A",
            "CurrencyCode": "MYR",
            "CreditTerm": "C.O.D.",
            "Address": "116 Jalan Damai, Kuala Lumpur, Wilayah Persekutuan"
        },
        {
            "AccNo": "300-D002",
            "CompanyName": "Customer B",
            "CurrencyCode": "MYR",
            "CreditTerm": "C.O.D.",
            "Address": "No. 1327, Jalan Padang Benggali, Butterworth, Pulau Pinang"
        },
        {
            "AccNo": "300-D003",
            "CompanyName": "Customer C",
            "CurrencyCode": "MYR",
            "CreditTerm": "C.O.D.",
            "Address": "34 Taman Taming Indah, Lorong Tengku Ahmad, Alor Setar, Selangor"
        }
    ],
    "totalCount": 4
}

Error Response

Response Body

object: Error Response Model

Example Error Response Body

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