Get Payment Listing (Simple)
Get payment listing using simple date filter.
Request
GET:/{accountBookId}/payment/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 |
docType | Cash book entry document type. List of document types can be found here. | string | nullable |
startDate | Starting date range. Returns document records where docDate falls on startDate or later. | date | nullable |
endDate | Ending date range. Returns document records where docDate falls on startDate or earlier. | date | nullable |
Example Request URL:
Parameters:accountBookId
= 1 page
= 1 docType
= "PV" startDate
= 2023-01-06 endDate
= 2023-03-06 URL:
GET: https://accounting-api.autocountcloud.com/1/payment/listing?page=1&docType=PVstartDate=2023-01-06&endDate=2023-03-06
Response
Success Response
Status Code: 200
Response Body
Field | Description | Type |
---|---|---|
data | Response data. | array[Cash Book Entry View Model] |
totalCount | Number of records retrieved. | number |
Example Success Response Body
{
"data": [
{
"master": {
"docKey": 92,
"docNo": "PV-000001",
"docNo2": null,
"docDate": "2023-03-06T00:00:00",
"taxDate": null,
"docType": "PV",
"currencyCode": "MYR",
"currencyRate": 1.000000000000,
"journalType": "GENERAL",
"dealWith": "Apparel Supplier",
"description": "Pants payment",
"note": null,
"cancelled": false,
"totalPayment": 472.50,
"localTotalPayment": 472.50,
"total": 472.50,
"localTotal": 472.50,
"totalExTax": 472.50,
"localTotalExTax": 472.50,
"taxableAmt": 0.00,
"localTaxableAmt": 0.00,
"tax": 0.00,
"localTax": 0.00,
"exTax": 0.00,
"localExTax": 0.00,
"netTotal": 472.50,
"localNetTotal": 472.50,
"createdTimeStamp": "2023-03-06T15:02:29.8201669",
"createdUserID": "ADMIN",
"lastModified": "2023-03-06T15:27:43.914987",
"lastModifiedUserID": "ADMIN",
"status": "Unapplied"
},
"details": [
{
"docKey": 92,
"dtlKey": 264,
"seq": 1,
"accNo": "400-0001",
"toAccountRate": 1.000000000000,
"description": "Payment for PI-000001\t",
"furtherDescription": null,
"amount": 472.50,
"localAmount": 472.50,
"taxCode": null,
"taxRate": null,
"taxAdjustment": 0.00,
"localTaxAdjustment": 0.00,
"tariffCode": null,
"taxExportCountry": null,
"taxPermitNo": null,
"taxBRNo": null,
"taxBName": null,
"taxRefNo": null,
"taxRegisterNo": null,
"taxBillDate": null,
"amountExTax": 472.50,
"localAmountExTax": 472.50,
"tax": 0.00,
"localTax": 0.00,
"amountWithTax": 472.50,
"localAmountWithTax": 472.50,
"salesAgent": null,
"inclusiveTax": true,
"deptNo": null
}
],
"paymentDetails": [
{
"docKey": 92,
"dtlKey": 265,
"seq": 1,
"paymentMethod": "CASH",
"paymentBy": null,
"chequeNo": null,
"floatDay": 0,
"bankCharge": 0.00,
"paymentAmt": 472.50,
"localPaymentAmt": 472.50,
"bankChargeTaxCode": null,
"bankChargeTaxRate": 0.000000,
"bankChargeTax": 0.00,
"bankChargeTaxRefNo": null,
"toBankRate": 1.000000000000
}
]
}
],
"totalCount": 1
}
Error Response
Response Body
object: Error Response Model
Example Error Response Body
{
"statusCode": 401,
"message": "401 Unauthorized."
}