Deposit Report

GET/v1/deposits/placements

Placement information

This endpoint allows you to retrieve a paginated list of all your deposit.

Request

Optional query

Name
page
Type
integer
Description
The page number of deposit returned.
- Default 1
Name
page_size
Type
integer
Description
The page size number of deposit returned.
- Default 10
Name
placement_date_from
Type
string
Description
Filter data by placement date.
Name
placement_date_to
Type
string
Description
Filter data by placement date.
Name
due_date_from
Type
string
Description
Filter data by due date.
Name
due_date_to
Type
string
Description
Filter data by due date.
Name
placement_type
Type
string
Description
Filter data by placement type.
Name
source_of_fund
Type
string
Description
Filter data by source of fund.
Name
owner_id
Type
string
Description
Filter data by owner.
Name
sort_by
Type
string
Description
Sort data by column.
Name
sort
Type
string
Description
Sort ascending or descending

Request

GET

/v1/deposits

const response = axios.get('/v1/deposits/placements', {
  "params": {
    "page": 1,
    "page_size": 10
  }
})

Response

  {
    "data": [
      {
        "_id": "637b569149e0c02e1036c35a",
        "date": "2024-03-24T00:00:00.000Z",
        "bilyetNumber": "BILYET001",
        "number": "DP/03/2024/001",
        "bank_id": "623fd4c6060a3208d98e3a4c",
        "account": {
          "number": "86401234",
          "name": "John"
        },
        "owner_id": "623fd5d8b5dfb53e27c0f3a2",
        "baseDate": 366,
        "tenor": 90,
        "dueDate": "2025-03-24T00:00:00.000Z",
        "isRollOver": true,
        "amount": 150000000,
        "remaining": 150000000,
        "sourceBank_id": "623fd4c6060a3208d98e3a4c",
        "sourceAccount": {
          "number": "86401234",
          "name": "John"
        },
        "recipientBank_id": "623fd4c6060a3208d98e3a4c",
        "recipientAccount": {
          "number": "86701235",
          "name": "Doe"
        },
        "paymentMethod": "advance",
        "interestRate": 3.5,
        "grossInterest": 1290984,
        "taxRate": 20,
        "taxAmount": 258197,
        "netInterest": 1032787,
        "returns": [
          {
            "baseDays": 30,
            "dueDate": "2024-04-24T00:00:00.000Z",
            "gross": 430328,
            "taxAmount": 86066,
            "net": 344262
          }
        ],
        "isCashback": true,
        "cashbacks": [
          {
            "rate": 5,
            "amount": 430328
          }
        ],
        "note": "this is note",
        "createdBy_id": "637d83d15d2be122007524bf",
        "createdAt": "2022-01-01T00:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 1,
      "pageCount": 1,
      "totalDocument": 2
    }
  }

GET/v1/deposits/realized-interest

Realized interest

This endpoint allows you to retrieve a paginated list of all your deposit.

Request

Optional query

Name
page
Type
integer
Description
The page number of deposit returned.
- Default 1
Name
page_size
Type
integer
Description
The page size number of deposit returned.
- Default 10
Name
placement_date_from
Type
string
Description
Filter data by placement date.
Name
placement_date_to
Type
string
Description
Filter data by placement date.
Name
placement_date_from
Type
string
Description
Filter data by due date.
Name
placement_date_to
Type
string
Description
Filter data by due date.
Name
placement_type
Type
string
Description
Filter data by placement type.
Name
source_of_fund
Type
string
Description
Filter data by source of fund.
Name
owner_id
Type
string
Description
Filter data by owner.

Request

GET

/v1/deposits

const response = axios.get('/v1/deposits', {
  "params": {
    "page": 1,
    "page_size": 10
  }
})

Response

  {
    "data": [
      {
        "_id": "637b569149e0c02e1036c35a",
        "dateReceived": "2024-03-24T00:00:00.000Z",
        "bilyetNumber": "BILYET001",
        "number": "DP/03/2024/001",
        "bank_id": "623fd4c6060a3208d98e3a4c",
        "account": {
          "number": "86401234",
          "name": "DBS"
        },
        "sourceBank_id": "623fd4c6060a3208d98e3a4c",
        "sourceAccount": {
          "number": "86401234",
          "name": "DBS"
        },
        "recipientBank_id": "623fd4c6060a3208d98e3a4c",
        "recipientAccount": {
          "number": "86701235",
          "name": "Doe"
        },
        "netInterestReceived": 1290984,
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 1,
      "pageCount": 1,
      "totalDocument": 2
    }
  }

GET/v1/deposits/value

Value information

This endpoint allows you to retrieve a paginated list of all your deposit.

Request

Optional query

Name
placement_date_from
Type
string
Description
Filter data by placement date.
Name
placement_date_to
Type
string
Description
Filter data by placement date.
Name
due_date_from
Type
string
Description
Filter data by due date.
Name
due_date_to
Type
string
Description
Filter data by due date.
Name
placement_type
Type
string
Description
Filter data by placement type.
Name
source_of_fund
Type
string
Description
Filter data by source of fund.
Name
owner_id
Type
string
Description
Filter data by owner.

Request

GET

/v1/deposits/value

const response = axios.get('/v1/deposits/value', {
  "params": {}
})

Response

  {
    "total_placement": 0,
    "total_gross_interest": 0,
    "total_tax": 0,
    "total_net_interest": 0,
    "total_placement_withdrawn": 0,
    "total_active_placements": 0,
    "total_pph_paid": 0,
    "total_net_interest_received": 0,
  }