Public/Finance/Agreements/Get-CWMAgreement.ps1
|
<#
.SYNOPSIS Gets agreements. .DESCRIPTION Retrieves the agreements from ConnectWise Manage, or a single agreement by id. Calls GET /finance/agreements; -id adds /{id} and -count adds /count. .PARAMETER id The id of a single agreement to retrieve. .PARAMETER count Return only the number of matching agreements instead of the records. .PARAMETER condition Filter in ConnectWise Manage condition syntax, for example "name contains 'Support'". .PARAMETER orderBy Sort order as 'field asc' or 'field desc', for example 'id desc'. .PARAMETER childConditions Filter on child (list) fields, in condition syntax. .PARAMETER customFieldConditions Filter on custom field values, in condition syntax. .PARAMETER page The page number to return. Use with -pageSize. .PARAMETER pageSize The number of records per page. Without it the API's default page size applies. .PARAMETER fields Only return these fields, for example @('id', 'name'). .PARAMETER all Retrieve every matching record, handling pagination automatically. .EXAMPLE Get-CWMAgreement -condition "name contains 'Support'" -all Retrieves the agreements that match the condition. .EXAMPLE Get-CWMAgreement -id 5 Retrieves agreement 5. .LINK https://developer.connectwise.com/manage/rest #> function Get-CWMAgreement { [CmdletBinding()] param( [int]$id, [switch]$count, [string]$condition, [ValidatePattern('\S* (desc|asc)')] [string]$orderBy, [string]$childConditions, [string]$customFieldConditions, [int]$page, [int]$pageSize, [string[]]$fields, [switch]$all ) $Endpoint = '/finance/agreements' Invoke-CWMGetMaster -Arguments $PsBoundParameters -Endpoint $Endpoint } |