@mbanq/core-sdk-js / commands / GetNoteById
Function: GetNoteById()
GetNoteById(
params):Command<{params: {noteId:number;resourceId:number;resourceType:string; }; }, {actionType: {code:string;id:number;value:string; };clientId?:number;createdById:number;createdByUsername:string;createdOn:string;entityId:number;entityType: {code:string;id:number;value:string; };id:number;note:string;updatedById:number;updatedByUsername:string;updatedOn:string; }>
Defined in: src/commands/rest/note.ts:171
Get a specific note by ID
Retrieves a single note by its ID for a specific resource. Returns detailed information about the note including who created it, when it was created, and the action type associated with it.
Parameters
params
Path parameters including resource type, resource ID, and note ID
noteId
number = ...
The unique identifier of the note
resourceId
number = ...
The unique identifier of the resource
resourceType
string = ...
The type of resource (e.g., 'clients', 'savingsaccount', 'loans')
Returns
Command<{ params: { noteId: number; resourceId: number; resourceType: string; }; }, { actionType: { code: string; id: number; value: string; }; clientId?: number; createdById: number; createdByUsername: string; createdOn: string; entityId: number; entityType: { code: string; id: number; value: string; }; id: number; note: string; updatedById: number; updatedByUsername: string; updatedOn: string; }>
Command object that executes the API request and returns the note details
Example
// Get a specific note for a client
const command = GetNoteById({
resourceType: 'clients',
resourceId: 123,
noteId: 456
});
const result = await client.request(command);