Public/BankDeposits/Get-AspireBankDeposits.ps1
|
<#
.SYNOPSIS Retrieves a list of bank deposits from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /BankDeposits endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "Status eq 'Open'"). .PARAMETER Top Optional number of records to return (integer). .PARAMETER Skip Optional number of records to skip (integer). .PARAMETER Select Optional comma-separated list of fields to include (e.g., "BankDepositID,Status"). .PARAMETER Expand Optional comma-separated list of related entities to expand (e.g., "BankAccount"). .PARAMETER OrderBy Optional OData orderby query (e.g., "Date desc"). .PARAMETER PageNumber Optional page number for pagination (integer). .PARAMETER Limit Optional limit for the number of records per page (integer). .OUTPUTS The response from the API containing the list of bank deposits. .EXAMPLE Get-AspireBankDeposits -Filter "Status eq 'Open'" -Top 10 -Skip 5 -Select "BankDepositID,Status" -Expand "BankAccount" -OrderBy "Date desc" -PageNumber 1 -Limit 20 #> function Get-AspireBankDeposits { [CmdletBinding()] param( [string]$Filter = $null, [int]$Top = $null, [int]$Skip = $null, [string]$Select = $null, [string]$Expand = $null, [string]$OrderBy = $null, [int]$PageNumber = $null, [int]$Limit = $null ) $queryParams = @{} if ($Filter) { $queryParams['$filter'] = $Filter } if ($Top) { $queryParams['$top'] = $Top } if ($Skip) { $queryParams['$skip'] = $Skip } if ($Select) { $queryParams['$select'] = $Select } if ($Expand) { $queryParams['$expand'] = $Expand } if ($OrderBy) { $queryParams['$orderby'] = $OrderBy } if ($PageNumber) { $queryParams['$pageNumber'] = $PageNumber } if ($Limit) { $queryParams['$limit'] = $Limit } return Invoke-AspireRequest -Method GET -Path "/BankDeposits" -QueryParams $queryParams } |