# Homotechsual Documentation
> Documentation for various homotechsual projects, including the HaloAPI and NinjaOne PowerShell modules as well as useful API documentation for some MSP focussed tools...
## Admonitions
### Admonitions
discord
Discord Admonition
[Link](/common/admonitions.md)
info
Info Admonition
[Link](/common/admonitions.md)
success
Success Admonition
[Link](/common/admonitions.md)
danger
Danger Admonition
[Link](/common/admonitions.md)
note
Note Admonition
[Link](/common/admonitions.md)
tip
Tip Admonition
[Link](/common/admonitions.md)
warning
Warning Admonition
[Link](/common/admonitions.md)
important
Important Admonition
[Link](/common/admonitions.md)
caution
Caution Admonition
[Link](/common/admonitions.md)
release
Release Admonition
[Link](/common/admonitions.md)
ninja
Ninja Admonition
[Link](/common/admonitions.md)
---
## Common
### Overview
[ ](https://discord.gg/NrCjh5ht7K)[](https://github.com/homotechsual/homotechsualdocs/) [](https://mit.license.homotechsual.dev/) [](https://github.com/sponsors/homotechsual/)
#### About[](#about "Direct link to About")
This section of the site holds documentation relating to common technologies used across other projects including information on how this documentation site is built. It is intentended to be used alongside the [Contributing](/contributing) section of the site which contains information on how to contribute to the various projects and the documentation itself.
#### Sections[](#sections "Direct link to Sections")
* [Docusaurus](/docs/docusaurus/) - Information on how this documentation site is built, the versions and key customisations applied.
* [CI / CD](/docs/ci-cd/) - Information on the CI / CD pipelines used across the various projects.
* [Build Tools](/docs/build-tools/) - Information on the build tools used across the various projects.
* [Code Quality](/docs/code-quality/) - Information on the code quality tools used across the various projects.
* [Coding Standards](/docs/coding-standards/) - Information on the coding standards used across the various projects and how they are enforced.
---
## Docusaurus
### Docusaurus
This site is built using [Docusaurus](https://docusaurus.io/), built using CloudFlare Workers and deployed to CloudFlare Pages.
The deployed version of the site includes a mixture of generated documentation and manually written documentation. Generated documentation is updated directly from the relevant source code repositories, while manually written documentation is updated by editing the Markdown files in the `docs` directory of this repository. Generated source files are indicated with an admonition at the top of the page.
#### How does the generated documentation get built?[](#how-does-the-generated-documentation-get-built "Direct link to How does the generated documentation get built?")
The generated documentation is built using a Microsoft Azure DevOps pipeline. The pipeline is triggered by any changes to the source code and triggers a custom build script which utilises a mixture of custom PowerShell and the `Alt.Docusaurus.PowerShell` PowerShell module to build the documentation into a format that can be consumed by Docusaurus.
The pipeline then commits the generated documentation to the `docs` directory of this repository, which is then deployed to CloudFlare Pages.
#### Docusaurus-compatible Markdown generation script[](#docusaurus-compatible-markdown-generation-script "Direct link to Docusaurus-compatible Markdown generation script")
You'll can find an example of the script used to generate our Docusaurus-compatible documentation in each of the module (or tool) repositories. The script will be part of the repository's `*.build.ps1` script file where `*` is the name of the module (or tool).
The script starts by building a module/tool specific list of files to exclude from the documentation. The way this is done depends on the module/tool, but generally involves excluding files that are not relevant to the documentation, such as build scripts, test scripts, etc and files which contain private or internal functions.
Gradually documentation will expand to cover private and internal functions, but for now we're only documenting public functions.
The script then builds parameters for the `New-DocusaurusMarkdown` function from the `Alt.Docusaurus.PowerShell` module. The parameters vary slightly depending on the structure/style of the module/tool.
The script then calls the `New-DocusaurusMarkdown` function to generate the Docusaurus-compatible Markdown files and rebuilds the docusaurus site.
After generating the docs the system goes through and adds some additional scaffolding files like `_category_.json` files used to mark sidebar categories for Docusaurus.
---
## Examples
### Overview
[ ](https://discord.gg/NrCjh5ht7K)[](https://github.com/homotechsual/homotechsualdocs/) [](https://mit.license.homotechsual.dev/) [](https://github.com/sponsors/homotechsual/)
#### About[](#about "Direct link to About")
This section of the site holds examples which use the various modules / tools documented on this site. These examples are meant to be used as a reference for how to use the modules / tools, not all are designed to be used as-is.
---
## Haloapi
### Overview
[](https://discord.gg/NrCjh5ht7K) [](https://discord.halopsa.community) [](https://discord.gg/vy53fYdPkW) [](https://github.com/homotechsual/haloapi/) [](https://github.com/homotechsual/HaloAPI/actions/workflows/release.yml) [](https://github.com/homotechsual/HaloAPI/actions/workflows/ci.yml) [](https://codecov.io/gh/homotechsual/HaloAPI) [](https://www.powershellgallery.com/packages/HaloAPI/) [](https://mit.license.homotechsual.dev) [](https://github.com/sponsors/homotechsual/) [](https://www.powershellgallery.com/packages/HaloAPI/) [](https://www.powershellgallery.com/packages/HaloAPI/)
#### About[](#about "Direct link to About")
This module provides a PowerShell interface to the Halo API. It's designed to for PowerShell developers to build their own PowerShell scripts and modules to interact with Halo. It's well tested for Halo Professional Services Automation (PSA) but should work with Halo IT Service Management (ITSM), Halo Service Desk and Halo Customer Relationship Management (CRM).
#### Code Coverage[](#code-coverage "Direct link to Code Coverage")
Code coverage is generated in CI for the `Meta` and `Unit` suites.
CI enforces a minimum 70% coverage threshold for the `Unit` suite.
Coverage artifacts are uploaded for each run as:
* `code-coverage-meta-results` (`.artifacts/CodeCoverage.meta.xml`)
* `code-coverage-unit-results` (`.artifacts/CodeCoverage.unit.xml`)
You can access them from the CI workflow runs:
[GitHub Actions CI workflow](https://github.com/homotechsual/HaloAPI/actions/workflows/ci.yml)
#### Installing[](#installing "Direct link to Installing")
This module is published to the [PowerShell Gallery](https://www.powershellgallery.com/packages/HaloAPI/). You can install it using the following command:
```powershell
Install-Module -Name HaloAPI
```
From time-to-time, preview releases will be published to the PowerShell Gallery. These are not considered stable and should not be used in production. You can install preview releases using the following command:
```powershell
Install-Module -Name HaloAPI -AllowPrerelease
```
#### Getting Started[](#getting-started "Direct link to Getting Started")
The first and probably most important requirement for this module is getting it connected to your Halo instance.
##### Creating an application in Halo[](#creating-an-application-in-halo "Direct link to Creating an application in Halo")
1. In your Halo instance head to **Configuration** > **Integrations** > **Halo PSA API**
This might be *Halo Service Desk API* or *Halo ITSM API*.
2. Select **View Applications**
All going well you should be at `config/integrations/api/applications`.
3. Select **New** to add a new API application.
4. Enter the **Application Name**.
For example *HaloAPI PS Module*.
5. Make sure you check the **Active** box.
6. Set the **Authentication Method** to *Client ID and Secret (Services)*.
7. Store the **Client ID** and **Client Secret** securely.
8. Set the **Login Type** and **Agent to login as** appropriately.
*This setting determines who appears to be responsible for these API calls. You may want to create a dedicated agent user for this purpose.*
9. Select the **Permissions** tab.
10. Grant the application the permissions required for your purposes.
*You should limit the API to only the permissions it needs to do the job you're scripting for.*
#### Known Issues[](#known-issues "Direct link to Known Issues")
Not all Halo's API endpoints have cmdlets but all documented endpoints exist in this module, along with many other undocumented endpoints. Want an endpoint / functionality implemented? Log an issue on [GitHub](https://github.com/homotechsual/haloapi/issues) and if possible someone might add it, or you can implement it yourself.
For little used or one-off endpoints you can call `Invoke-HaloRequest` directly to reuse the same authentication token/connection and run arbitrary requests. See the [cmdlet documentation](/modules/haloapi/commandlets/invoke/Invoke-HaloRequest.mdx) for more information.
---
### Connect to Services
#### [ Connect-HaloAPI](/modules/haloapi/commandlets/Connect/Connect-HaloAPI.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Connect/Connect-HaloAPI.md)
---
### Create Data
#### [ New-HaloAction](/modules/haloapi/commandlets/New/New-HaloAction.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/New/New-HaloAction.md)
---
### Invoke Actions
#### [ Invoke-HaloRequest](/modules/haloapi/commandlets/Invoke/Invoke-HaloRequest.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Invoke/Invoke-HaloRequest.md)
---
### Remove Data
#### [ Remove-HaloAction](/modules/haloapi/commandlets/Remove/Remove-HaloAction.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Remove/Remove-HaloAction.md)
---
### Restore Data
#### [ Restore-HaloTicket](/modules/haloapi/commandlets/Restore/Restore-HaloTicket.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Restore/Restore-HaloTicket.md)
---
### Retrieve Information
#### [ Get-HaloAction](/modules/haloapi/commandlets/Get/Get-HaloAction.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Get/Get-HaloAction.md)
---
### Update Data (Set)
#### [ Set-HaloAction](/modules/haloapi/commandlets/Set/Set-HaloAction.md)
[This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.](/modules/haloapi/commandlets/Set/Set-HaloAction.md)
---
### Connect-HaloAPI
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Creates a new connection to a Halo instance.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
```powershell
Connect-HaloAPI [-URL ] [-ClientID ] [-ClientSecret ] [-Scopes ]
[-Tenant ] [-AdditionalHeaders ] [-UseKeyVault ] [-SecretName ]
[-VaultName ] [-SaveToKeyVault ] [-UseManagedIdentity] [-MaxRetries ] [-NoConfirm]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Creates a new connection to a Halo instance and stores this in a PowerShell Session.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
##### EXAMPLE 1[](#example-1 "Direct link to EXAMPLE 1")
```powershell
Connect-HaloAPI -URL "https://example.halopsa.com" -ClientId "c9534241-dde9-4d04-9d45-32b1fbff22ed" -ClientSecret "14c0c9af-2db1-48ab-b29c-51975df4afa2-739e4ef2-9aad-4fe9-b486-794feca48ea8" -Scopes "all" -Tenant "demo" -VaultName "MyVault" -SaveToKeyVault $true
This logs into Halo using the Client Credentials authorisation flow and saves the secrets to the specified Azure Key Vault for future use.
```
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -URL[](#-url "Direct link to -URL")
The URL of the Halo instance to connect to. Not required if UseKeyVault is set to $true.
```yaml
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
The Client ID for the application configured in Halo. Not required if UseKeyVault is set to $true.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientSecret[](#-clientsecret "Direct link to -ClientSecret")
The Client Secret for the application configured in Halo. Not required if UseKeyVault is set to $true.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Scopes[](#-scopes "Direct link to -Scopes")
The API scopes to request, if this isn't passed the scope is assumed to be "all". Pass a string or array of strings. Limited by the scopes granted to the application in Halo.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Tenant[](#-tenant "Direct link to -Tenant")
The tenant name required for hosted Halo instances.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AdditionalHeaders[](#-additionalheaders "Direct link to -AdditionalHeaders")
Hashtable containing additional parameters to be sent with each request.
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -UseKeyVault[](#-usekeyvault "Direct link to -UseKeyVault")
If $true, retrieve parameters from Azure Key Vault. If $false, use parameters passed to function.
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SecretName[](#-secretname "Direct link to -SecretName")
The name of the secret in the Azure Key Vault.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -VaultName[](#-vaultname "Direct link to -VaultName")
The name of the Azure Key Vault.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SaveToKeyVault[](#-savetokeyvault "Direct link to -SaveToKeyVault")
If $true, save parameters to Azure Key Vault. If $false or not specified, do not save parameters.
```yaml
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -UseManagedIdentity[](#-usemanagedidentity "Direct link to -UseManagedIdentity")
When set to $true, uses a Managed Identity to connect to Azure Key Vault instead of interactive login.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -MaxRetries[](#-maxretries "Direct link to -MaxRetries")
The maximum number of times to retry requests before giving up.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False
```
##### -NoConfirm[](#-noconfirm "Direct link to -NoConfirm")
Don't return a boolean to confirm the connection status.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### System.Void[](#systemvoid "Direct link to System.Void")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAction
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets actions from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAction [-Count ] -TicketID [-ExcludeSys] [-ConversationOnly] [-AgentOnly]
[-SupplierOnly] [-ExcludePrivate] [-IncludeHTMLNote] [-IncludeHTMLEmail] [-IncludeAttachments]
[-ImportantOnly] [-SLAOnly] [-IsChildNotes] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAction -ActionID -TicketID [-AgentOnly] [-IncludeEmail] [-IncludeDetails] [-MostRecent]
[-EmailOnly] [-NonSystem] [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves actions from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -ActionID[](#-actionid "Direct link to -ActionID")
Action ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of actions to return.
```yaml
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketID[](#-ticketid "Direct link to -TicketID")
Get actions for a single ticket with the specified ID. \[HaloPipelineIDArgumentTransformation()]
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: ticket_id
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
##### -ExcludeSys[](#-excludesys "Direct link to -ExcludeSys")
Exclude system-performed actions.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ConversationOnly[](#-conversationonly "Direct link to -ConversationOnly")
Only get actions that are part of agent to end user conversations.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AgentOnly[](#-agentonly "Direct link to -AgentOnly")
Only get actions performed by agents.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SupplierOnly[](#-supplieronly "Direct link to -SupplierOnly")
Only get actions that involve suppliers.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ExcludePrivate[](#-excludeprivate "Direct link to -ExcludePrivate")
Exclude private actions.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeHTMLNote[](#-includehtmlnote "Direct link to -IncludeHTMLNote")
Include the action note HTML in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeHTMLEmail[](#-includehtmlemail "Direct link to -IncludeHTMLEmail")
Include the action email HTML in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeAttachments[](#-includeattachments "Direct link to -IncludeAttachments")
Include attachment details in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ImportantOnly[](#-importantonly "Direct link to -ImportantOnly")
Only get important actions.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SLAOnly[](#-slaonly "Direct link to -SLAOnly")
Only get SLA hold and release actions.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IsChildNotes[](#-ischildnotes "Direct link to -IsChildNotes")
Only get actions from child tickets.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeEmail[](#-includeemail "Direct link to -IncludeEmail")
Include the HTML and plain text email body in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra detail objects.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -MostRecent[](#-mostrecent "Direct link to -MostRecent")
Ignore the '-ActionID' and get the most recent action for the '-TicketID'
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -EmailOnly[](#-emailonly "Direct link to -EmailOnly")
Only get email actions.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -NonSystem[](#-nonsystem "Direct link to -NonSystem")
Exclude system-performed actions.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAgent
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets agents from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAgent [-Team ] [-Search ] [-SectionID ] [-DepartmentID ]
[-ClientID ] [-Role ] [-IncludeEnabled] [-IncludeDisabled] [-IncludeUnassigned] [-IncludeRoles]
[-ShowAll] [-IncludeAPIAgents] [-CanEditOnly] [-IncludeNamedCount] [-ProgressAction ]
[]
```
##### Me[](#me "Direct link to Me")
```powershell
Get-HaloAgent [-Me] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAgent -AgentID [-IncludeDetails] [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves agents from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -Me[](#-me "Direct link to -Me")
Get the agent object for the access token owner
```yaml
Type: SwitchParameter
Parameter Sets: Me
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AgentID[](#-agentid "Direct link to -AgentID")
Agent ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Team[](#-team "Direct link to -Team")
Filter by the specified team name.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Filter by name, email address or telephone number using the specified search string.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SectionID[](#-sectionid "Direct link to -SectionID")
Filter by the specified team ID. ?ACT Query with Halo what this does!
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: section_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -DepartmentID[](#-departmentid "Direct link to -DepartmentID")
Filter by the specified department ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: department_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
Filter by the specified client ID (agents who have access to this client).
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Role[](#-role "Direct link to -Role")
Filter by the specified role ID (requires int as string.)
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeEnabled[](#-includeenabled "Direct link to -IncludeEnabled")
Include agents with enabled accounts (defaults to $True).
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDisabled[](#-includedisabled "Direct link to -IncludeDisabled")
Include agents with disabled accounts.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeUnassigned[](#-includeunassigned "Direct link to -IncludeUnassigned")
Include the system unassigned agent account.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeRoles[](#-includeroles "Direct link to -IncludeRoles")
Include the agent's roles list in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra detail objects (for example teams and roles) in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Show all agents, including those that have been deleted.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeAPIAgents[](#-includeapiagents "Direct link to -IncludeAPIAgents")
Include API agents in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -CanEditOnly[](#-caneditonly "Direct link to -CanEditOnly")
Show only agents the API user has permissions to edit.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: can_edit_only
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeNamedCount[](#-includenamedcount "Direct link to -IncludeNamedCount")
Include counts of named license consumption in the response.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAppointment
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets appointments from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAppointment [-ShowAll] [-StartDate ] [-EndDate ] [-Agents ] [-ShowHolidays]
[-ShowProjects] [-ShowChanges] [-ShowAppointments] [-Search ] [-AppointmentsOnly] [-TasksOnly]
[-HideCompleted] [-TicketID ] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAppointment -AppointmentID [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves appointments from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -AppointmentID[](#-appointmentid "Direct link to -AppointmentID")
Appointment ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Admin override to return all appointments
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -StartDate[](#-startdate "Direct link to -StartDate")
Return appointments with a start date greater than this value.
```yaml
Type: String
Parameter Sets: Multi
Aliases: start_date
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -EndDate[](#-enddate "Direct link to -EndDate")
Return appointments with an end date greater than this value
```yaml
Type: String
Parameter Sets: Multi
Aliases: end_date
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Agents[](#-agents "Direct link to -Agents")
Comma separated list of agent IDs. Returns these agent's appointments
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowHolidays[](#-showholidays "Direct link to -ShowHolidays")
Include the appointment type 'holiday' in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowProjects[](#-showprojects "Direct link to -ShowProjects")
Include projects in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowChanges[](#-showchanges "Direct link to -ShowChanges")
Include change requests in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAppointments[](#-showappointments "Direct link to -ShowAppointments")
Include appointments in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Return appointments like this search string
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AppointmentsOnly[](#-appointmentsonly "Direct link to -AppointmentsOnly")
Only return appointments in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TasksOnly[](#-tasksonly "Direct link to -TasksOnly")
Only return tasks in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -HideCompleted[](#-hidecompleted "Direct link to -HideCompleted")
Exclude completed appointments from the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketID[](#-ticketid "Direct link to -TicketID")
Return appointments assigned to a particular ticket
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Whether to include extra objects in the response
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAsset
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets assets from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAsset [-Paginate] [-PageSize ] [-PageNo ] [-Search ] [-TicketID ]
[-ClientID ] [-SiteID ] [-Username ] [-AssetGroupID ] [-AssetTypeID ]
[-LinkedToID ] [-includeinactive] [-includeactive] [-includechildren] [-ContractID ]
[-FullObjects] [-AdvancedSearch ] [-AssetGroups ] [-AssetStatuses ]
[-AssetTypes ] [-Bookmarked] [-ColumnsID ] [-Consignable] [-IncludeBillingPeriod]
[-Count ] [-DomotzAgents] [-ExcludeThese ] [-IDOnly] [-includeallowedstatus]
[-includeassetfields] [-includecolumns] [-includeservices] [-includeuser] [-IntegrationTenantIDs ]
[-InventoryNumber ] [-ItemId ] [-ItemStockId ] [-KBId ] [-lastupdatefromdate]
[-lastupdatetodate] [-LicenseID ] [-Mine] [-MySite] [-NoIcon] [-Order ] [-OrderDesc]
[-Order2 ] [-OrderDesc2] [-Order3 ] [-OrderDesc3] [-Order4 ] [-OrderDesc4]
[-Order5 ] [-OrderDesc5] [-ServiceId ] [-ServiceIds ] [-StockBinId ]
[-StockBinIds ] [-SupplierContractId ] [-SupplierId ] [-SupplierContracts ]
[-TicketTypeId ] [-UserId ] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAsset -AssetID [-IncludeDetails] [-IncludeDiagramDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves assets from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -AssetID[](#-assetid "Direct link to -AssetID")
Asset ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: $Script:HAPIDefaultPageSize
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Filter by Assets with an asset field like your search
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketID[](#-ticketid "Direct link to -TicketID")
Filter by Assets belonging to a particular ticket
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
Filter by Assets belonging to a particular client
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SiteID[](#-siteid "Direct link to -SiteID")
Filter by Assets belonging to a particular site
```yaml
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Username[](#-username "Direct link to -Username")
Filter by Assets belonging to a particular user
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetGroupID[](#-assetgroupid "Direct link to -AssetGroupID")
Filter by Assets belonging to a particular Asset group
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: assetgroup_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetTypeID[](#-assettypeid "Direct link to -AssetTypeID")
Filter by Assets belonging to a particular Asset type
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: assettype_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -LinkedToID[](#-linkedtoid "Direct link to -LinkedToID")
Filter by Assets linked to a particular Asset
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: linkedto_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeinactive[](#-includeinactive "Direct link to -includeinactive")
Include inactive Assets in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeactive[](#-includeactive "Direct link to -includeactive")
Include active Assets in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includechildren[](#-includechildren "Direct link to -includechildren")
Include child Assets in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ContractID[](#-contractid "Direct link to -ContractID")
Filter by Assets linked to a particular Asset
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: contract_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -FullObjects[](#-fullobjects "Direct link to -FullObjects")
Parameter to return the complete objects.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDiagramDetails[](#-includediagramdetails "Direct link to -IncludeDiagramDetails")
Include the last action in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AdvancedSearch[](#-advancedsearch "Direct link to -AdvancedSearch")
Advanced search query
```yaml
Type: String
Parameter Sets: Multi
Aliases: advanced_search
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetGroups[](#-assetgroups "Direct link to -AssetGroups")
Asset groups to filter by
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetStatuses[](#-assetstatuses "Direct link to -AssetStatuses")
Asset statuses to filter by
```yaml
Type: String[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetTypes[](#-assettypes "Direct link to -AssetTypes")
Asset types to filter by
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Bookmarked[](#-bookmarked "Direct link to -Bookmarked")
Filter by bookmarked assets
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ColumnsID[](#-columnsid "Direct link to -ColumnsID")
Use the provided column profile
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: columns_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Consignable[](#-consignable "Direct link to -Consignable")
Filter by consignable assets
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeBillingPeriod[](#-includebillingperiod "Direct link to -IncludeBillingPeriod")
Include the billing period of the linked contract id
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: contract_id_adding_to
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
Return this number of assets.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -DomotzAgents[](#-domotzagents "Direct link to -DomotzAgents")
Filter by assets with a linked Domotz agent
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ExcludeThese[](#-excludethese "Direct link to -ExcludeThese")
Exclude assets by id
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IDOnly[](#-idonly "Direct link to -IDOnly")
Return only the asset id
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeallowedstatus[](#-includeallowedstatus "Direct link to -includeallowedstatus")
Include the asset column `tallowallstatus` in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeassetfields[](#-includeassetfields "Direct link to -includeassetfields")
Include the asset fields in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includecolumns[](#-includecolumns "Direct link to -includecolumns")
Include column details in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeservices[](#-includeservices "Direct link to -includeservices")
Include assets linked service ids in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeuser[](#-includeuser "Direct link to -includeuser")
Include the user details in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IntegrationTenantIDs[](#-integrationtenantids "Direct link to -IntegrationTenantIDs")
Filter by integration tenant ids
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases: integration_tenantids
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -InventoryNumber[](#-inventorynumber "Direct link to -InventoryNumber")
Filter by inventory number
```yaml
Type: String
Parameter Sets: Multi
Aliases: inventory_number
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ItemId[](#-itemid "Direct link to -ItemId")
Filter by linked item id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: item_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ItemStockId[](#-itemstockid "Direct link to -ItemStockId")
Filter by linked item stock id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: itemstock_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -KBId[](#-kbid "Direct link to -KBId")
Filter by linked kb article id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: kb_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -lastupdatefromdate[](#-lastupdatefromdate "Direct link to -lastupdatefromdate")
Include the last update from date in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -lastupdatetodate[](#-lastupdatetodate "Direct link to -lastupdatetodate")
Include the last update to date in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -LicenseID[](#-licenseid "Direct link to -LicenseID")
Filter by assets assigned to a particular license
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: license_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Mine[](#-mine "Direct link to -Mine")
Filter to assets owned by the current user
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -MySite[](#-mysite "Direct link to -MySite")
Filter to assets in the current user's site
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -NoIcon[](#-noicon "Direct link to -NoIcon")
Exclude the asset icon from the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
First field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Order results for the first field in descending order (respects the field choice in '-OrderBy')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order2[](#-order2 "Direct link to -Order2")
Second field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc2[](#-orderdesc2 "Direct link to -OrderDesc2")
Order results for the second field in descending order (respects the field choice in '-OrderBy2')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order3[](#-order3 "Direct link to -Order3")
Third field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc3[](#-orderdesc3 "Direct link to -OrderDesc3")
Order results for the third field in descending order (respects the field choice in '-OrderBy3')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order4[](#-order4 "Direct link to -Order4")
Fourth field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc4[](#-orderdesc4 "Direct link to -OrderDesc4")
Order results for the fourth field in descending order (respects the field choice in '-OrderBy4')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order5[](#-order5 "Direct link to -Order5")
Fifth field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc5[](#-orderdesc5 "Direct link to -OrderDesc5")
Order results for the fifth field in descending order (respects the field choice in '-OrderBy5')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ServiceId[](#-serviceid "Direct link to -ServiceId")
Filter by assets belonging to a particular service
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: service_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ServiceIds[](#-serviceids "Direct link to -ServiceIds")
Filter by assets belonging to any of the specified services
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases: service_ids
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -StockBinId[](#-stockbinid "Direct link to -StockBinId")
Filter by stockbin id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: stockbin_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -StockBinIds[](#-stockbinids "Direct link to -StockBinIds")
Filter by stockbin ids
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases: stockbin_ids
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SupplierContractId[](#-suppliercontractid "Direct link to -SupplierContractId")
Filter by supplier contract id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: supplier_contract_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SupplierId[](#-supplierid "Direct link to -SupplierId")
Filter by supplier id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: supplier_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SupplierContracts[](#-suppliercontracts "Direct link to -SupplierContracts")
Filter by supplier contract ids
```yaml
Type: Int32[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketTypeId[](#-tickettypeid "Direct link to -TicketTypeId")
Filter by assets with linked tickets of the given type
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: tickettype_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -UserId[](#-userid "Direct link to -UserId")
Filter by assets belonging to the given user id
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: user_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAssetType
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets asset types from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAssetType [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-OrderDesc]
[-Search ] [-AssetGroupID ] [-includeinactive] [-includeactive] [-FullObjects] [-ShowAll]
[-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAssetType -AssetTypeID [-IncludeDetails] [-IncludeDiagramDetails]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves asset types from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -AssetTypeID[](#-assettypeid "Direct link to -AssetTypeID")
Asset Type ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: $Script:HAPIDefaultPageSize
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
Which field to order results based on.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Order results in descending order (respects the field choice in '-Order')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Filter by AssetTypes with an asset type group like your search
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AssetGroupID[](#-assetgroupid "Direct link to -AssetGroupID")
Filter by Asset Types belonging to a particular Asset group
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: assetgroup_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeinactive[](#-includeinactive "Direct link to -includeinactive")
Include inactive Asset Types in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeactive[](#-includeactive "Direct link to -includeactive")
Include active Asset Types in the response
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -FullObjects[](#-fullobjects "Direct link to -FullObjects")
Parameter to return the complete objects.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDiagramDetails[](#-includediagramdetails "Direct link to -IncludeDiagramDetails")
Include the last action in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Show all assets, including those that have been deleted.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAttachment
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets attachments from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAttachment -TicketID [-ActionID ] [-Type ] [-UniqueID ]
[-ProgressAction ] []
```
##### SinglePath[](#singlepath "Direct link to SinglePath")
```powershell
Get-HaloAttachment -AttachmentID -OutPath [-ProgressAction ]
[]
```
##### SingleFile[](#singlefile "Direct link to SingleFile")
```powershell
Get-HaloAttachment -AttachmentID -OutFile [-ProgressAction ]
[]
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAttachment -AttachmentID [-IncludeDetails] [-AsBase64] [-GetToken]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves attachments from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -AttachmentID[](#-attachmentid "Direct link to -AttachmentID")
Attachment ID
```yaml
Type: Int64
Parameter Sets: SinglePath, SingleFile, Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketID[](#-ticketid "Direct link to -TicketID")
Returns attachments from the ticket ID specified
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ActionID[](#-actionid "Direct link to -ActionID")
Returns attachments from the action ID specified (requires ticket\_id)
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: action_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Type[](#-type "Direct link to -Type")
Returns attachments of the specified type
```yaml
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -UniqueID[](#-uniqueid "Direct link to -UniqueID")
Returns an attachment with the unique ID specified
```yaml
Type: Int64
Parameter Sets: Multi
Aliases: unique_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OutFile[](#-outfile "Direct link to -OutFile")
Allow Writing Directly to File, using the specified path and file name eg c:\temp\myfile.txt
```yaml
Type: String
Parameter Sets: SingleFile
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OutPath[](#-outpath "Direct link to -OutPath")
Allow Writing Directly to File, using the specified path and the original file name eg c:\temp\\
```yaml
Type: String
Parameter Sets: SinglePath
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -AsBase64[](#-asbase64 "Direct link to -AsBase64")
Return the attachment as a base64 encoded string
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -GetToken[](#-gettoken "Direct link to -GetToken")
Get the token for accessing the image using the token parameter(s).
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloAzureADConnection
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets Azure AD Connection information from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloAzureADConnection [-Type ] [-ShowAll ] [-ProgressAction ]
[]
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloAzureADConnection -AzureConnectionID [-Type ] [-IncludeDetails] [-IncludeTenants]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves Azure AD Connection from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -AzureConnectionID[](#-azureconnectionid "Direct link to -AzureConnectionID")
Lookup Item ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Type[](#-type "Direct link to -Type")
Type
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Show All
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include Details
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeTenants[](#-includetenants "Direct link to -IncludeTenants")
Include Tenants
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloBillingTemplate
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets billing templates from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloBillingTemplate [-ShowAll] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloBillingTemplate -TemplateID [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves billing templates from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -TemplateID[](#-templateid "Direct link to -TemplateID")
Template ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Show all results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: show_all
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include details in results
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloCategory
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets Category information from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloCategory [-TypeID ] [-ShowAll] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloCategory -CategoryID [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves Category types from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -CategoryID[](#-categoryid "Direct link to -CategoryID")
Category ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TypeID[](#-typeid "Direct link to -TypeID")
Type ID
```yaml
Type: String
Parameter Sets: Multi
Aliases: type_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Include Details
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloClient
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets clients from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloClient [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-OrderDesc]
[-Search ] [-TopLevelID ] [-IncludeActive] [-IncludeInactive] [-Count ] [-FullObjects]
[-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloClient -ClientID [-IncludeDetails] [-IncludeActivity] [-IncludePrepay]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves clients from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -ClientID[](#-clientid "Direct link to -ClientID")
Client ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
Which field to order results based on.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Order results in descending order (respects the field choice in '-Order')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Return clients matching the search term in the results.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TopLevelID[](#-toplevelid "Direct link to -TopLevelID")
Filter by the specified top level ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: toplevel_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeActive[](#-includeactive "Direct link to -IncludeActive")
Include active clients in the results.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeInactive[](#-includeinactive "Direct link to -IncludeInactive")
Include inactive clients in the results.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of clients to return if not using pagination.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -FullObjects[](#-fullobjects "Direct link to -FullObjects")
Parameter to return the complete objects.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeActivity[](#-includeactivity "Direct link to -IncludeActivity")
Include ticket activity in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludePrepay[](#-includeprepay "Direct link to -IncludePrepay")
Include prepay objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloContract
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets contracts from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloContract [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-OrderDesc]
[-Search ] [-Count ] [-FullObjects] [-ClientID ] [-ProgressAction ]
[]
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloContract -ContractID [-includeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves contracts from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -ContractID[](#-contractid "Direct link to -ContractID")
Contract ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
Which field to order results based on.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Order results in descending order (respects the field choice in '-Order')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Return contracts matching the search term in the results.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of contracts to return if not using pagination.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -FullObjects[](#-fullobjects "Direct link to -FullObjects")
Parameter to return the complete objects.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -includeDetails[](#-includedetails "Direct link to -includeDetails")
Include invoice Details
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
Filter by the specified client ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloControl
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets control information from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
```powershell
Get-HaloControl [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves control information from the Halo API.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A PowerShell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A PowerShell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloCRMNote
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets CRM notes from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloCRMNote [-Count ] -ClientID [-IncludeHTMLNote] [-IncludeAttachments]
[-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloCRMNote -CRMNoteID [-Count ] [-IncludeHTMLNote] [-IncludeAttachments]
[-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves CRM notes from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -CRMNoteID[](#-crmnoteid "Direct link to -CRMNoteID")
CRM note ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of CRM notes to return.
```yaml
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
Get CRM notes for a single client with the specified ID. \[HaloPipelineIDArgumentTransformation()]
```yaml
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[](#-includehtmlnote "Direct link to -IncludeHTMLNote")
Include the CRM note HTML in the response.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeAttachments[](#-includeattachments "Direct link to -IncludeAttachments")
Include attachment details in the response.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloCustomButton
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets custom buttons from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloCustomButton [-Type ] [-TypeID ] [-IsButtonSetup] [-IncludeDetails]
[-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloCustomButton -CustomButtonID [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves custom buttons from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -CustomButtonID[](#-custombuttonid "Direct link to -CustomButtonID")
Custom Button ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Type[](#-type "Direct link to -Type")
Filter by the specified type.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TypeID[](#-typeid "Direct link to -TypeID")
Filter by the specified type ID.
```yaml
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IsButtonSetup[](#-isbuttonsetup "Direct link to -IsButtonSetup")
Include custom buttons which are setup (defaults to $True).
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra detail objects in the response.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloCustomField
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets Custom Fields from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloCustomField [-Count ] [-Paginate] [-PageSize ] [-PageNo ] [-Order ]
[-OrderDesc] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloCustomField -CustomFieldID [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves Custom Fields from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -CustomFieldID[](#-customfieldid "Direct link to -CustomFieldID")
Item ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
Number of records to return
```yaml
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
The name of the first field to order by
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Whether to order ascending or descending
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloCustomTable
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets custom tables from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloCustomTable [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloCustomTable -CustomTableId [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves custom tables from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -CustomTableId[](#-customtableid "Direct link to -CustomTableId")
Custom Table ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloDashboard
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets dashboards from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloDashboard [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloDashboard -DashboardID [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves dashboards from the Halo API.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -DashboardID[](#-dashboardid "Direct link to -DashboardID")
Dashboard ID.
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A PowerShell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A PowerShell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloDistributionList
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets distribution lists from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloDistributionList [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-OrderDesc]
[-Search ] [-Count ] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloDistributionList -DistributionListID [-IncludeDetails] [-ProgressAction ]
[]
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves distribution lists from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -DistributionListID[](#-distributionlistid "Direct link to -DistributionListID")
Distribution List ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Order[](#-order "Direct link to -Order")
The field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderDesc[](#-orderdesc "Direct link to -OrderDesc")
Order results in descending order (respects the field choice in '-Order')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Return distribution lists matching the search term in the results.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of distribution lists to return if not using pagination.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include extra objects in the result.
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloDistributionListMember
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets members of a distribution list from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
```powershell
Get-HaloDistributionListMember [-DistributionListID] [-Paginate] [[-PageSize] ]
[[-PageNo] ] [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves members of a specific distribution list from the Halo API.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -DistributionListID[](#-distributionlistid "Direct link to -DistributionListID")
Distribution List ID
```yaml
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: page_size
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases: page_no
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloFAQList
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets FAQ List information from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloFAQList [-Type ] [-ShowAll ] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloFAQList -FAQListID [-IncludeDetails] [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves FAQ Lists from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -FAQListID[](#-faqlistid "Direct link to -FAQListID")
Lookup Item ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Type[](#-type "Direct link to -Type")
Type
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ShowAll[](#-showall "Direct link to -ShowAll")
Show All
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include Details
```yaml
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloField
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets field information from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloField [-Kind ] [-IncludeDetails] [-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloField -FieldID [-Kind ] [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves field types from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -FieldID[](#-fieldid "Direct link to -FieldID")
Lookup Item ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Kind[](#-kind "Direct link to -Kind")
Kind
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -IncludeDetails[](#-includedetails "Direct link to -IncludeDetails")
Include Details
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloInvoice
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets invoices from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloInvoice [-Count ] [-Search ] [-Paginate] [-PageSize ] [-PageNo ]
[-OrderBy ] [-OrderByDesc] [-OrderBy2 ] [-OrderByDesc2] [-OrderBy3 ] [-OrderByDesc3]
[-OrderBy4 ] [-OrderByDesc4] [-OrderBy5 ] [-OrderByDesc5] [-TicketID ]
[-ClientID ] [-SiteID ] [-UserID ] [-PostedOnly] [-NotPostedOnly]
[-PaymentStatuses ] [-PaymentStatusIds ] [-ProgressAction ]
[]
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloInvoice -InvoiceID [-ProgressAction ] []
```
#### DESCRIPTION[](#description "Direct link to DESCRIPTION")
Retrieves invoices from the Halo API - supports a variety of filtering parameters.
#### EXAMPLES[](#examples "Direct link to EXAMPLES")
#### PARAMETERS[](#parameters "Direct link to PARAMETERS")
##### -InvoiceID[](#-invoiceid "Direct link to -InvoiceID")
Invoice ID
```yaml
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Count[](#-count "Direct link to -Count")
The number of invoices to return if not using pagination.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Search[](#-search "Direct link to -Search")
Return contracts matching the search term in the results.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -Paginate[](#-paginate "Direct link to -Paginate")
Paginate results
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageSize[](#-pagesize "Direct link to -PageSize")
Number of results per page.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PageNo[](#-pageno "Direct link to -PageNo")
Which page to return.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderBy[](#-orderby "Direct link to -OrderBy")
First field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderByDesc[](#-orderbydesc "Direct link to -OrderByDesc")
Order results for the first field in descending order (respects the field choice in '-OrderBy')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderBy2[](#-orderby2 "Direct link to -OrderBy2")
Second field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderByDesc2[](#-orderbydesc2 "Direct link to -OrderByDesc2")
Order results for the second field in descending order (respects the field choice in '-OrderBy2')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderBy3[](#-orderby3 "Direct link to -OrderBy3")
Third field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderByDesc3[](#-orderbydesc3 "Direct link to -OrderByDesc3")
Order results for the third field in descending order (respects the field choice in '-OrderBy3')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderBy4[](#-orderby4 "Direct link to -OrderBy4")
Fourth field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderByDesc4[](#-orderbydesc4 "Direct link to -OrderByDesc4")
Order results for the fourth field in descending order (respects the field choice in '-OrderBy4')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderBy5[](#-orderby5 "Direct link to -OrderBy5")
Fifth field to order the results by.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -OrderByDesc5[](#-orderbydesc5 "Direct link to -OrderByDesc5")
Order results for the fifth field in descending order (respects the field choice in '-OrderBy5')
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -TicketID[](#-ticketid "Direct link to -TicketID")
Filter by the specified ticket ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: ticket_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -ClientID[](#-clientid "Direct link to -ClientID")
Filter by the specified client ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -SiteID[](#-siteid "Direct link to -SiteID")
Filter by the specified site ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: site_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -UserID[](#-userid "Direct link to -UserID")
Filter by the specified user ID.
```yaml
Type: Int32
Parameter Sets: Multi
Aliases: user_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PostedOnly[](#-postedonly "Direct link to -PostedOnly")
Filter for posted invoices only.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -NotPostedOnly[](#-notpostedonly "Direct link to -NotPostedOnly")
Filter for non-posted invoices only.
```yaml
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PaymentStatuses[](#-paymentstatuses "Direct link to -PaymentStatuses")
Filter by payment status. Provide a string separated by HTML encoded commas.
```yaml
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### -PaymentStatusIds[](#-paymentstatusids "Direct link to -PaymentStatusIds")
Filter by payment status. Provide an array of integers.
```yaml
Type: Int64[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
##### CommonParameters[](#commonparameters "Direct link to 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](http://go.microsoft.com/fwlink/?LinkID=113216).
#### INPUTS[](#inputs "Direct link to INPUTS")
#### OUTPUTS[](#outputs "Direct link to OUTPUTS")
##### A powershell object containing the response.[](#a-powershell-object-containing-the-response "Direct link to A powershell object containing the response.")
#### NOTES[](#notes "Direct link to NOTES")
#### RELATED LINKS[](#related-links "Direct link to RELATED LINKS")
---
### Get-HaloItem
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
#### SYNOPSIS[](#synopsis "Direct link to SYNOPSIS")
Gets items from the Halo API.
#### SYNTAX[](#syntax "Direct link to SYNTAX")
##### Multi (Default)[](#multi-default "Direct link to Multi (Default)")
```powershell
Get-HaloItem [-Count ] [-Search ] [-Paginate] [-PageSize ] [-PageNo ]
[-OrderBy ] [-OrderByDesc] [-OrderBy2 ] [-OrderByDesc2] [-OrderBy3 ] [-OrderByDesc3]
[-OrderBy4 ] [-OrderByDesc4] [-OrderBy5 ] [-OrderByDesc5] [-IncludeInactive]
[-ProgressAction ] []
```
##### Single[](#single "Direct link to Single")
```powershell
Get-HaloItem -ItemID [-IncludeDetails] [-ProgressAction