Skip to main content

Get Creditor Listing

Request

GET:/{accountBookId}/creditor/listing

Request Parameters

ParameterDescriptionType
pagePage 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.numberrequired
activeOnlyActive only flag. When field value is "true", only active creditors will be included in the query.boolean
fieldList 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 creditors 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/creditor/listing?activeOnly=true&field=creditTerm&field=address&page=1

Response

Success Response

Status Code: 200

Response Body

FieldDescriptionType
dataResponse data.array[Creditor Data Model]
totalCountNumber of records retrieved.number
Example Success Response Body
{
"data": [
{
"AccNo": "400-0001",
"CompanyName": "Apparel Supplier",
"CurrencyCode": "MYR",
"CreditTerm": "C.O.D.",
"Address": "Jalan Wawasan 4/12, Pusat Bandar Puchong, Puchong, Selangor"
},
{
"AccNo": "400-0002",
"CompanyName": "Furniture Supplier",
"CurrencyCode": "MYR",
"CreditTerm": "C.O.D.",
"Address": "No. 33 Jln Sungai Rasa Sungai Rasa, Klang, Selangor"
}
],
"totalCount": 2
}

Error Response

Response Body

object: Error Response Model

Example Error Response Body
{
"statusCode": 401,
"message": "401 Unauthorized."
}