@mbanq/core-sdk-js / commands / GetCreditAccountCompletedTransactions
Function: GetCreditAccountCompletedTransactions()
GetCreditAccountCompletedTransactions(
creditAccountId,data?):Command<{creditAccountId:number;data?: {endDate?:string;paymentTransactionsOnly?:boolean;startDate?:string;unbilledTransactionsOnly?:boolean; }; }, {pageItems:object[];totalFilteredRecords:number; }>
Defined in: src/commands/rest/creditAccount.ts:147
Get completed transactions for a credit account
Retrieves all completed transactions for a specific credit account, excluding pending transactions. Completed transactions are those successfully sent to the recipient (e.g., incoming returns credited to the account, outgoing ACH transactions sent to the bank).
Parameters
creditAccountId
number
The unique identifier of the credit account
data?
endDate?
string = ...
paymentTransactionsOnly?
boolean = ...
startDate?
string = ...
unbilledTransactionsOnly?
boolean = ...
Returns
Command<{ creditAccountId: number; data?: { endDate?: string; paymentTransactionsOnly?: boolean; startDate?: string; unbilledTransactionsOnly?: boolean; }; }, { pageItems: object[]; totalFilteredRecords: number; }>
Command object that executes the API request and returns completed transactions
Example
// Get all completed transactions
const command = GetCreditAccountCompletedTransactions(1);
const transactions = await client.request(command);
// Get unbilled transactions only
const unbilledCommand = GetCreditAccountCompletedTransactions(1, { unbilledTransactionsOnly: true });
const unbilledTransactions = await client.request(unbilledCommand);
// Get transactions within a date range
const dateRangeCommand = GetCreditAccountCompletedTransactions(1, {
startDate: '2023-01-18',
endDate: '2023-02-14'
});
const datedTransactions = await client.request(dateRangeCommand);