@mbanq/core-sdk-js / commands / GetNotes
Function: GetNotes()
GetNotes(
params):Command<{params: {resourceId:number;resourceType:ResourceType; }; },object[]>
Defined in: src/commands/rest/note.ts:119
Get notes for a resource
Retrieves all notes associated with a specific resource. Notes include information about actions taken on the resource, who created them, and when they were created.
Parameters
params
Path parameters including resource type and resource ID
resourceId
number = ...
The unique identifier of the resource
resourceType
ResourceType = ...
The type of resource (e.g., 'clients', 'savingsaccount', 'loans')
Returns
Command<{ params: { resourceId: number; resourceType: ResourceType; }; }, object[]>
Command object that executes the API request and returns the list of notes
Example
typescript
// Get notes for a client
const command = GetNotes({
resourceType: 'clients',
resourceId: 123
});
const result = await client.request(command);
// Get notes for a savings account
const accountNotes = GetNotes({
resourceType: 'savingsaccount',
resourceId: 456
});
const notesResult = await client.request(accountNotes);