Retrieve Book Register By ID

Overview

The RetrieveBookRegisterByIdQuery retrieves detailed information for a specific book register by its unique identifier.

API Endpoint

POST /api/bpm/cmd

Headers

Content-Type: application/json
Authorization: Bearer {access_token}
X-Tenant-ID: {tenant_id}

Request Structure

{
  "cmd": "RetrieveBookRegisterByIdQuery",
  "data": {
    "id": 789
  }
}

Request Fields

Field	Type	Required	Description
id	long	Yes	The unique identifier of the book register

Sample Request

{
  "cmd": "RetrieveBookRegisterByIdQuery",
  "data": {
    "id": 789
  }
}

Response Structure

Success Response

{
  "isSuccessful": true,
  "message": "Book register retrieved successfully.",
  "statusCode": "00",
  "data": {
    "id": 789,
    "bookType": 1,
    "bookTypeDescription": "Cheque",
    "bookReference": "CHQ-2024-001",
    "depositAccountId": 12345,
    "accountNumber": "1234567890",
    "clientId": 67890,
    "clientName": "John Doe",
    "issuingBranchId": 5,
    "branchName": "Main Branch",
    "branchKey": "MB001",
    "currencyCode": "NGN",
    "currencyName": "Nigerian Naira",
    "startSerialNumber": "0001001",
    "endSerialNumber": "0001050",
    "numberOfLeaves": 50,
    "issuedDate": "2024-12-01T00:00:00Z",
    "status": 1,
    "statusDescription": "ACTIVE",
    "isActive": true,
    "remarks": "Initial cheque book issuance",
    "createdAt": "2024-12-01T10:30:00Z",
    "createdBy": "admin@bank.com",
    "updatedAt": "2024-12-01T10:30:00Z",
    "updatedBy": "admin@bank.com"
  }
}

Error Response (Not Found)

{
  "isSuccessful": false,
  "message": "Book register not found.",
  "statusCode": "99",
  "data": null
}

Response Fields

Field	Description
id	Unique identifier of the book register
bookType	Numeric book type (1=Cheque, 2=DepositSlip, 3=WithdrawalSlip)
bookTypeDescription	Human-readable book type
bookReference	Optional reference number for the book
depositAccountId	ID of the deposit account
accountNumber	Account number
clientId	ID of the account holder
clientName	Full name of the account holder
issuingBranchId	ID of the branch that issued the book
branchName	Name of the issuing branch
branchKey	Branch code/key
currencyCode	ISO currency code (e.g., NGN, USD)
currencyName	Full currency name
startSerialNumber	First serial number in the book
endSerialNumber	Last serial number in the book
numberOfLeaves	Total number of leaves/pages
issuedDate	Date the book was issued
status	Numeric status (1=ACTIVE, 2=INACTIVE, 3=BLOCKED)
statusDescription	Human-readable status
isActive	Boolean indicating if status is ACTIVE
remarks	Notes about the book register
createdAt	Timestamp when record was created
createdBy	User who created the record
updatedAt	Timestamp of last update
updatedBy	User who last updated the record

Notes

• This command internally uses RetrieveBookRegistersListQuery with the ID filter
• Returns 404 status if the book register does not exist
• Includes full related data: deposit account, client details, branch information, and currency
• Client names are automatically resolved based on client classification (individual/group)
• Results are cached for improved performance

Related Commands

• Retrieve Book Register List - Get list of all book registers with filtering
• Update Book Register - Modify book register details
• Activate Book Register - Activate an inactive book register
• Deactivate Book Register - Deactivate an active book register
• Block Book Register - Block a book register for security