Skip to main content

Retrieve Deposit Comments

Retrieves all comments for a specific deposit account.

Command Name​

RetrieveDepositCommentListQuery

Endpoint​

POST /api/core/cmd

Request Parameters​

ParameterTypeRequiredDescription
depositIdlongYesDeposit account ID
pageNumberintegerNoPage number (default: 1)
pageSizeintegerNoItems per page (default: 20)
isExportbooleanNoExport all results (default: false)

Request Example​

{
  "Cmd": "RetrieveDepositCommentListQuery",
  "Data": {
    "depositId": 54321,
    "pageNumber": 1,
    "pageSize": 50
  }
}

Alternative: Use RetrieveCommentsListQuery​

You can also use the generic command:

{
  "Cmd": "RetrieveCommentsListQuery",
  "Data": {
    "entity": "Deposit",
    "entityId": 54321,
    "pageSize": 50
  }
}

Response Structure​

{
  "IsSuccessful": true,
  "StatusCode": "00",
  "Message": "8/8 records returned.",
  "Data": {
    "items": [
      {
        "Id": 3001,
        "ClientId": 67890,
        "Comment": "Fixed deposit matured. Customer opted for renewal.",
        "ClientName": "Jane Smith",
        "ClientEndodedKey": "CLIENT-67890",
        "ClientCode": "CL-000456",
        "EncodedKey": "DEP-54321",
        "AssociatedEntity": "Deposit",
        "AssociatedEntityId": 54321,
        "AssociatedEntityNumber": "DEP-54321",
        "DateCreated": "2025-12-24T09:00:00Z",
        "UserName": "deposit.officer@banklingo.com"
      }
    ],
    "PageNumber": 1,
    "PageSize": 8,
    "TotalPages": 1,
    "TotalRecords": 8
  }
}

Code Example​

async function getDepositComments(depositId: number, pageSize: number = 20) {
  const response = await fetch('/api/core/cmd', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify({
      Cmd: 'RetrieveDepositCommentListQuery',
      Data: { depositId, pageSize }
    })
  });
  
  return await response.json();
}

// Usage
const comments = await getDepositComments(54321, 50);