Skip to main content

Get Credit Note Listing (Specific)

Get credit note listing using specific listing filters.

Request​

POST:/{accountBookId}/creditNote/listing

Request Body​

object: Credit Note Listing Input Model

Example Request Body
Get credit note listing using a date filter

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

Example: Get credit note 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 credit note listing using a string filter

Available string filters for credit note records are docNo, debtorCode and salesAgent. Add string filters in credit note listing filter input model according to your needs.

Example: Get credit note records with specific document numbers.

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

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

Example: Get credit note 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": "CN-000001",
      "to": "CN-000005"
    }
  }
}

Composite example:

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

Example Request URL:

Parameters:
accountBookId = 1

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

Response​

Success Response​

Status Code: 200

Response Body​

FieldDescriptionType
dataResponse data.array[Credit Note View Model]
totalCountNumber of records retrieved.number
Example Success Response Body
 {
    "data": [
        {
            "master": {
                "docKey": 56,
                "docNo": "CN-000001",
                "docDate": "2023-03-06T00:00:00",
                "taxDate": null,
                "debtorCode": "300-D002",
                "debtorName": "Customer B",
                "currencyCode": "MYR",
                "currencyRate": 1.000000000000,
                "email": "debtorB@gmail.com",
                "emailCC": null,
                "emailBCC": null,
                "address": "No. 1327, Jalan Padang Benggali, Butterworth, Pulau Pinang",
                "attention": "",
                "phone1": "04-656 3345",
                "fax1": "",
                "deliverAddress": "No. 1327, Jalan Padang Benggali, Butterworth, Pulau Pinang",
                "deliverContact": "",
                "deliverPhone1": "",
                "deliverFax1": "",
                "ref": null,
                "description": null,
                "note": null,
                "creditTerm": "C.O.D.",
                "salesAgent": "Bob",
                "salesLocation": "HQ",
                "remark1": null,
                "remark2": null,
                "remark3": null,
                "remark4": null,
                "inclusiveTax": false,
                "isRoundAdj": false,
                "cancelled": false,
                "totalExTax": 450.00,
                "taxableAmt": 450.00,
                "localTaxableAmt": 450.00,
                "tax": 22.50,
                "localTax": 22.50,
                "exTax": 22.50,
                "localExTax": 22.50,
                "netTotal": 472.50,
                "localNetTotal": 472.50,
                "roundAdj": 0.00,
                "total": 450.00,
                "finalTotal": 472.50,
                "createdTimeStamp": "2023-03-06T16:42:18.4848536",
                "createdUserID": "ADMIN",
                "lastModified": "2023-03-06T16:42:26.9875477",
                "lastModifiedUserID": "ADMIN",
                "ourInvoiceNo": null,
                "reason": "Incorrect size",
                "status": "Fully Applied"
            },
            "details": [
                {
                    "docKey": 56,
                    "dtlKey": 98,
                    "seq": 0,
                    "productId": 11,
                    "productCode": "P-00002",
                    "productVariantId": null,
                    "productVariant1Option": null,
                    "productVariant2Option": null,
                    "accNo": "510-0000",
                    "description": "Pants",
                    "furtherDescription": "",
                    "qty": 1.00000000,
                    "unit": "pairs",
                    "unitPrice": 450.00000000,
                    "discount": null,
                    "discountAmt": 0.00,
                    "taxCode": "S-5",
                    "taxRate": 5.000000,
                    "taxAdjustment": 0.00,
                    "localTaxAdjustment": 0.00,
                    "tariffCode": "40159000",
                    "taxExportCountry": null,
                    "taxPermitNo": null,
                    "unitCost": 300.00000000,
                    "subTotalExTax": 450.00,
                    "localSubTotalExTax": 450.00,
                    "tax": 22.50,
                    "localTax": 22.50,
                    "subTotal": 450.00,
                    "localSubTotal": 450.00,
                    "goodsReturn": true,
                    "yourPONo": null,
                    "yourPODate": null,
                    "deptNo": null
                }
            ]
        }
    ],
    "totalCount": 1
}

Error Response​

Response Body​

object: Error Response Model

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