Skip to main content

Get Knock Off Entry Listing (Specific)

Get knock off entry listing using specific listing filters.

Request​

POST:/{accountBookId}/knockOffEntry/listing

Request Body​

object: Knock Off Entry Listing Input Model

Example Request Body
Get knock off entry listing using a date filter

Available date filters for knock off entry records are date, createdDate and lastModifiedDate. Add date filters in knock off entry listing filter input model according to your needs.

Example: Get knock off entry records with document date falling between a specific date range.

Date formats for from and to fields can be found here.

{
  "page": 1,
  "filter": {
    "date": {
      "from": "2022-05-02",
      "to": "2023-05-02"
    }
  }
}
Get knock off entry listing using a string filter

Available string filters for knock off entry records are docNo and accNo. Add string filters in knock off entry listing filter input model according to your needs.

Example: Get knock off entry records with specific document numbers.

For filtering specific string values, use the multiSelect field in the filter.

{
  "page": 1,
  "filter": {
    "docNo": {
      "multiSelect": ["KO-000001", "KO-000002"]
    }
  }
}

Example: Get knock off entry records with document number falling between a range of string values.

For filtering a range of string values, use the from and to fields in the filter.

{
  "page": 1,
  "filter": {
    "docNo": {
      "from": "KO-000001",
      "to": "KO-000005"
    }
  }
}

Composite example:

{
  "page": 1,
  "filter": {
    "date": {
      "from": "2023-01-06",
      "to": "2023-05-06"
    },
    "docNo": {
      "multiSelect": ["KO-000001","KO-000003","KO-000005"]
    }
  }
}

Example Request URL:

Parameters:
accountBookId = 1

URL:
POST: https://accounting-api.autocountcloud.com/1/knockOffEntry/listing

Response​

Success Response​

Status Code: 200

Response Body​

FieldDescriptionType
dataResponse data.array[Knock Off Entry View Model]
totalCountNumber of records retrieved.number
Example Success Response Body
{
    "data": [
        {
            "master": {
                "knockOffKey": 120,
                "accNo": "300-D002",
                "companyName": "Customer B",
                "currencyCode": "MYR",
                "deptNo": null,
                "docNo": "KO-000001",
                "docDate": "2023-03-15T00:00:00",
                "totalDR": 472.50,
                "totalCR": 472.50,
                "localTotalDR": 472.50,
                "localTotalCR": 472.50,
                "gainLoss": 0.00,
                "createdTimeStamp": "2023-03-17T10:52:37.9344045",
                "createdUserID": "ADMIN",
                "lastModified": "2023-03-17T10:52:37.934556",
                "lastModifiedUserID": "ADMIN"
            },
            "details": [
                {
                    "knockOffKey": 120,
                    "koTransKey": 204,
                    "knockOffAmount": -472.50,
                    "localKnockOffAmount": -472.50,
                    "sourceType": "CN",
                    "sourceKey": 56,
                    "sourceDtlKey": null,
                    "docNo": "CN-000001",
                    "docDate": "2023-03-06T00:00:00",
                    "currencyCode": "MYR",
                    "currencyRate": 1.000000000000,
                    "amount": -472.50,
                    "localAmount": -472.50
                },
                {
                    "knockOffKey": 120,
                    "koTransKey": 240,
                    "knockOffAmount": 472.50,
                    "localKnockOffAmount": 472.50,
                    "sourceType": "JE",
                    "sourceKey": 294,
                    "sourceDtlKey": 631,
                    "docNo": "JV-000003",
                    "docDate": "2023-03-15T00:00:00",
                    "currencyCode": "MYR",
                    "currencyRate": 1.000000000000,
                    "amount": 472.50,
                    "localAmount": 472.50
                }
            ]
        }
    ],
    "totalCount": 1
}

Error Response​

Response Body​

object: Error Response Model

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