Public/Finance/AgreementAdditions/Get-CWMAgreementAddition.ps1
|
<#
.SYNOPSIS Gets the agreement additions of an agreement. .DESCRIPTION Retrieves the agreement additions of an agreement from ConnectWise Manage, or a single agreement addition by id. Calls GET /finance/agreements/{parentId}/additions; -id adds /{id} and -count adds /count. .PARAMETER parentId The id of the agreement. Alias: AgreementID .PARAMETER id The id of a single agreement addition to retrieve. .PARAMETER count Return only the number of matching agreement additions instead of the records. .PARAMETER condition Filter in ConnectWise Manage condition syntax, for example "description contains 'laptop'". .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', 'description'). .PARAMETER all Retrieve every matching record, handling pagination automatically. .EXAMPLE Get-CWMAgreementAddition -parentId 12 -condition "description contains 'laptop'" -all Retrieves the agreement additions of agreement 12 that match the condition. .EXAMPLE Get-CWMAgreementAddition -parentId 12 -id 5 Retrieves agreement addition 5 of agreement 12. .LINK https://developer.connectwise.com/manage/rest #> function Get-CWMAgreementAddition { [CmdletBinding()] param( [Parameter(Mandatory=$true)] [Alias('AgreementID')] [int]$parentId, [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/$($parentId)/additions" Invoke-CWMGetMaster -Arguments $PsBoundParameters -Endpoint $Endpoint } |