Get-HaloCRMNote
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets CRM notes from the Halo API. https://mjcoltd.halopsa.com/api/CRMNote?count=15&client_id=29&includehtmlnote=true&includeattachments=true
SYNTAX
Multi (Default)
Get-HaloCRMNote [-Count <Int64>] -ClientID <Int32> [-IncludeHTMLNote] [-IncludeAttachments]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloCRMNote -CRMNoteID <Int64> [-Count <Int64>] [-IncludeHTMLNote] [-IncludeAttachments]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves CRM notes from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-CRMNoteID
CRM note ID.
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Count
The number of CRM notes to return.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Get CRM notes for a single client with the specified ID. [HaloPipelineIDArgumentTransformation()]
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-IncludeHTMLNote
Include the CRM note HTML in the response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeAttachments
Include attachment details in the response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.