HaloAPI
1.16.0
This module provides an interface to the Halo API.
Minimum PowerShell version
7.0
Installation Options
Author(s)
Mikey O'Toole / Luke Whitelock
Copyright
(c) 2021 Mikey O'Toole & Luke Whitelock. All rights reserved.
Package Details
Owners
Tags
HaloPSA PSA Halo API HaloServiceSolutions HaloITSM HaloServiceDesk ITSM Service Desk REST MSP Automation
Functions
Connect-HaloAPI Get-HaloAction Get-HaloAgent Get-HaloAppointment Get-HaloAsset Get-HaloAssetType Get-HaloAttachment Get-HaloAzureADConnection Get-HaloBillingTemplate Get-HaloCategory Get-HaloClient Get-HaloContract Get-HaloCRMNote Get-HaloCustomButton Get-HaloCustomField Get-HaloCustomTable Get-HaloFAQList Get-HaloField Get-HaloInvoice Get-HaloItem Get-HaloKBArticle Get-HaloLookup Get-HaloObjectTemplate Get-HaloOpportunity Get-HaloProject Get-HaloPurchaseOrder Get-HaloQuote Get-HaloRecurringInvoice Get-HaloRelease Get-HaloReport Get-HaloSalesOrder Get-HaloService Get-HaloSite Get-HaloSoftwareLicence Get-HaloStatus Get-HaloSupplier Get-HaloTeam Get-HaloTicket Get-HaloTicketRules Get-HaloTicketType Get-HaloTimesheet Get-HaloUser Get-HaloWorkday Get-HaloWorkflow Get-HaloWorkflows Invoke-HaloRequest New-HaloAction New-HaloActionBatch New-HaloAgent New-HaloAgentBatch New-HaloAppointment New-HaloAppointmentBatch New-HaloAsset New-HaloAssetBatch New-HaloAssetType New-HaloAttachment New-HaloAttachmentBatch New-HaloBillingTemplate New-HaloCategory New-HaloClient New-HaloClientBatch New-HaloContract New-HaloContractBatch New-HaloCRMNote New-HaloCustomButton New-HaloCustomField New-HaloCustomTable New-HaloCustomFieldBatch New-HaloFAQList New-HaloInvoice New-HaloInvoiceBatch New-HaloItem New-HaloItemBatch New-HaloKBArticle New-HaloKBArticleBatch New-HaloOpportunity New-HaloOpportunityBatch New-HaloProject New-HaloProjectBatch New-HaloQuote New-HaloQuoteBatch New-HaloRecurringInvoice New-HaloRecurringInvoiceBatch New-HaloReport New-HaloReportBatch New-HaloService New-HaloServiceBatch New-HaloSite New-HaloSiteBatch New-HaloSoftwareLicence New-HaloSoftwareLicenseBatch New-HaloStatus New-HaloSupplier New-HaloSupplierBatch New-HaloTeam New-HaloTeamBatch New-HaloTicket New-HaloTicketBatch New-HaloTicketType New-HaloTicketTypeBatch New-HaloUser New-HaloUserBatch New-HaloWorkday New-HaloWorkflow New-HaloWorkflowBatch Remove-HaloAction Remove-HaloActionBatch Remove-HaloAgent Remove-HaloAgentBatch Remove-HaloAssetType Remove-HaloCategory Remove-HaloClient Remove-HaloClientBatch Remove-HaloContract Remove-HaloCRMNote Remove-HaloItem Remove-HaloKBArticle Remove-HaloTicket Remove-HaloTicketBatch Remove-HaloTicketRules Remove-HaloUser Restore-HaloTicket Set-HaloAction Set-HaloAgent Set-HaloAppointment Set-HaloAsset Set-HaloAssetType Set-HaloAttachment Set-HaloBillingTemplate Set-HaloCategory Set-HaloClient Set-HaloContract Set-HaloCRMNote Set-HaloCustomButton Set-HaloFAQList Set-HaloInvoice Set-HaloItem Set-HaloKBArticle Set-HaloOpportunity Set-HaloProject Set-HaloQuote Set-HaloRecurringInvoice Set-HaloRecurringTemplate Set-HaloReport Set-HaloSite Set-HaloSoftwareLicence Set-HaloStatus Set-HaloSupplier Set-HaloTeam Set-HaloTicket Set-HaloTicketType Set-HaloTicketRules Set-HaloUser Set-HaloWorkday New-HaloTab Get-HaloTabs Get-HaloOutcome New-HaloOutcome
Dependencies
This module has no dependencies.
Release Notes
Refactor `Invoke-HaloRequest` to avoid reusing variable names and keep the scope clearer. Fixes breakage with PowerShell 7.4.0.
FileList
- HaloAPI.nuspec
- CHANGELOG.md
- Classes\Validators\HaloAuthScopesValidator.psm1
- Data\Templates\KBArticle.json
- Private\Get-TokenExpiry.ps1
- Public\Get\Get-HaloAppointment.ps1
- Public\Get\Get-HaloFAQList.ps1
- Public\Get\Get-HaloRelease.ps1
- Public\Get\Get-HaloTimesheet.ps1
- Public\New\New-HaloAttachment.ps1
- Public\New\New-HaloFAQList.ps1
- Public\New\New-HaloQuoteBatch.ps1
- Public\New\New-HaloSupplierBatch.ps1
- Public\Remove\Remove-HaloAction.ps1
- Public\Remove\Remove-HaloTicketBatch.ps1
- Public\Set\Set-HaloClient.ps1
- Public\Set\Set-HaloRecurringTemplate.ps1
- Classes\Validators\HaloCustomButtonValidator.psm1
- Data\Templates\Opportunity.json
- Private\Invoke-HaloBatchProcessor.ps1
- Public\Get\Get-HaloAsset.ps1
- Public\Get\Get-HaloField.ps1
- Public\Get\Get-HaloReport.ps1
- Public\Get\Get-HaloUser.ps1
- Public\New\New-HaloAttachmentBatch.ps1
- Public\New\New-HaloInvoice.ps1
- Public\New\New-HaloRecurringInvoice.ps1
- Public\New\New-HaloTab.ps1
- Public\Remove\Remove-HaloActionBatch.ps1
- Public\Remove\Remove-HaloTicketRules.ps1
- Public\Set\Set-HaloContract.ps1
- Public\Set\Set-HaloReport.ps1
- HaloAPI.psd1
- Classes\Validators\HaloLookupValidator.psm1
- Data\Templates\Project.json
- Private\Invoke-HaloPreFlightCheck.ps1
- Public\Get\Get-HaloAssetType.ps1
- Public\Get\Get-HaloInvoice.ps1
- Public\Get\Get-HaloSalesOrder.ps1
- Public\Get\Get-HaloWorkday.ps1
- Public\New\New-HaloBillingTemplate.ps1
- Public\New\New-HaloInvoiceBatch.ps1
- Public\New\New-HaloRecurringInvoiceBatch.ps1
- Public\New\New-HaloTeam.ps1
- Public\Remove\Remove-HaloAgent.ps1
- Public\Remove\Remove-HaloUser.ps1
- Public\Set\Set-HaloCRMNote.ps1
- Public\Set\Set-HaloSite.ps1
- HaloAPI.psm1
- Data\Templates\Action.json
- Data\Templates\Quote.json
- Private\New-HaloDELETERequest.ps1
- Public\Get\Get-HaloAttachment.ps1
- Public\Get\Get-HaloItem.ps1
- Public\Get\Get-HaloService.ps1
- Public\Get\Get-HaloWorkflow.ps1
- Public\New\New-HaloCategory.ps1
- Public\New\New-HaloItem.ps1
- Public\New\New-HaloReport.ps1
- Public\New\New-HaloTeamBatch.ps1
- Public\Remove\Remove-HaloAgentBatch.ps1
- Public\Restore\Restore-HaloTicket.ps1
- Public\Set\Set-HaloCustomButton.ps1
- Public\Set\Set-HaloSoftwareLicence.ps1
- LICENSE.md
- Data\Templates\Agent.json
- Data\Templates\Report.json
- Private\New-HaloError.ps1
- Public\Get\Get-HaloAzureADConnection.ps1
- Public\Get\Get-HaloKBArticle.ps1
- Public\Get\Get-HaloSite.ps1
- Public\New\New-HaloAction.ps1
- Public\New\New-HaloClient.ps1
- Public\New\New-HaloItemBatch.ps1
- Public\New\New-HaloReportBatch.ps1
- Public\New\New-HaloTicket.ps1
- Public\Remove\Remove-HaloAssetType.ps1
- Public\Set\Set-HaloAction.ps1
- Public\Set\Set-HaloFAQList.ps1
- Public\Set\Set-HaloStatus.ps1
- README.md
- Data\Templates\Appointment.json
- Data\Templates\Site.json
- Private\New-HaloGETRequest.ps1
- Public\Get\Get-HaloBillingTemplate.ps1
- Public\Get\Get-HaloLookup.ps1
- Public\Get\Get-HaloSoftwareLicence.ps1
- Public\New\New-HaloActionBatch.ps1
- Public\New\New-HaloClientBatch.ps1
- Public\New\New-HaloKBArticle.ps1
- Public\New\New-HaloService.ps1
- Public\New\New-HaloTicketBatch.ps1
- Public\Remove\Remove-HaloCategory.ps1
- Public\Set\Set-HaloAgent.ps1
- Public\Set\Set-HaloInvoice.ps1
- Public\Set\Set-HaloSupplier.ps1
- Classes\HaloAuth.psm1
- Data\Templates\Asset.json
- Data\Templates\Status.json
- Private\New-HaloPOSTRequest.ps1
- Public\Get\Get-HaloCategory.ps1
- Public\Get\Get-HaloObjectTemplate.ps1
- Public\Get\Get-HaloStatus.ps1
- Public\New\New-HaloAgent.ps1
- Public\New\New-HaloContract.ps1
- Public\New\New-HaloKBArticleBatch.ps1
- Public\New\New-HaloServiceBatch.ps1
- Public\New\New-HaloTicketType.ps1
- Public\Remove\Remove-HaloClient.ps1
- Public\Set\Set-HaloAppointment.ps1
- Public\Set\Set-HaloItem.ps1
- Public\Set\Set-HaloTeam.ps1
- Classes\HaloCustomButton.psm1
- Data\Templates\Attachment.json
- Data\Templates\Supplier.json
- Private\New-HaloQuery.ps1
- Public\Get\Get-HaloClient.ps1
- Public\Get\Get-HaloOpportunity.ps1
- Public\Get\Get-HaloSupplier.ps1
- Public\New\New-HaloAgentBatch.ps1
- Public\New\New-HaloContractBatch.ps1
- Public\New\New-HaloOpportunity.ps1
- Public\New\New-HaloSite.ps1
- Public\New\New-HaloTicketTypeBatch.ps1
- Public\Remove\Remove-HaloClientBatch.ps1
- Public\Set\Set-HaloAsset.ps1
- Public\Set\Set-HaloKBArticle.ps1
- Public\Set\Set-HaloTicket.ps1
- Classes\HaloLookup.psm1
- Data\Templates\Client.json
- Data\Templates\Team.json
- Private\Write-Success.ps1
- Public\Get\Get-HaloContract.ps1
- Public\Get\Get-HaloOutcome.ps1
- Public\Get\Get-HaloTabs.ps1
- Public\New\New-HaloAppointment.ps1
- Public\New\New-HaloCRMNote.ps1
- Public\New\New-HaloOpportunityBatch.ps1
- Public\New\New-HaloSiteBatch.ps1
- Public\New\New-HaloUser.ps1
- Public\Remove\Remove-HaloContract.ps1
- Public\Set\Set-HaloAssetType.ps1
- Public\Set\Set-HaloOpportunity.ps1
- Public\Set\Set-HaloTicketRules.ps1
- Classes\Completers\HaloAuthScopesCompleter.psm1
- Data\Templates\Contract.json
- Data\Templates\Ticket.json
- Public\Connect-HaloAPI.ps1
- Public\Get\Get-HaloCRMNote.ps1
- Public\Get\Get-HaloProject.ps1
- Public\Get\Get-HaloTeam.ps1
- Public\New\New-HaloAppointmentBatch.ps1
- Public\New\New-HaloCustomButton.ps1
- Public\New\New-HaloOutcome.ps1
- Public\New\New-HaloSoftwareLicence.ps1
- Public\New\New-HaloUserBatch.ps1
- Public\Remove\Remove-HaloCRMNote.ps1
- Public\Set\Set-HaloAttachment.ps1
- Public\Set\Set-HaloProject.ps1
- Public\Set\Set-HaloTicketType.ps1
- Classes\Completers\HaloCustomButtonCompleter.psm1
- Data\Templates\CustomButton.json
- Data\Templates\TicketType.json
- Public\Invoke-HaloRequest.ps1
- Public\Get\Get-HaloCustomButton.ps1
- Public\Get\Get-HaloPurchaseOrder.ps1
- Public\Get\Get-HaloTicket.ps1
- Public\New\New-HaloAsset.ps1
- Public\New\New-HaloCustomField.ps1
- Public\New\New-HaloProject.ps1
- Public\New\New-HaloSoftwareLicenseBatch.ps1
- Public\New\New-HaloWorkday.ps1
- Public\Remove\Remove-HaloItem.ps1
- Public\Set\Set-HaloBillingTemplate.ps1
- Public\Set\Set-HaloQuote.ps1
- Public\Set\Set-HaloUser.ps1
- Classes\Completers\HaloLookupCompleter.psm1
- Data\Templates\Invoice.json
- Data\Templates\User.json
- Public\Get\Get-HaloAction.ps1
- Public\Get\Get-HaloCustomField.ps1
- Public\Get\Get-HaloQuote.ps1
- Public\Get\Get-HaloTicketRules.ps1
- Public\New\New-HaloAssetBatch.ps1
- Public\New\New-HaloCustomFieldBatch.ps1
- Public\New\New-HaloProjectBatch.ps1
- Public\New\New-HaloStatus.ps1
- Public\New\New-HaloWorkflow.ps1
- Public\Remove\Remove-HaloKBArticle.ps1
- Public\Set\Set-HaloCategory.ps1
- Public\Set\Set-HaloRecurringInvoice.ps1
- Public\Set\Set-HaloWorkday.ps1
- Classes\Transformations\HaloPipelineIDArgumentTransformation.psm1
- Data\Templates\Item.json
- Private\Get-HaloNullObject.ps1
- Public\Get\Get-HaloAgent.ps1
- Public\Get\Get-HaloCustomTable.ps1
- Public\Get\Get-HaloRecurringInvoice.ps1
- Public\Get\Get-HaloTicketType.ps1
- Public\New\New-HaloAssetType.ps1
- Public\New\New-HaloCustomTable.ps1
- Public\New\New-HaloQuote.ps1
- Public\New\New-HaloSupplier.ps1
- Public\New\New-HaloWorkflowBatch.ps1
- Public\Remove\Remove-HaloTicket.ps1
Version History
Version | Downloads | Last updated |
---|---|---|
1.16.0 (current version) | 5,571 | 11/17/2023 |
1.15.0 | 11,694 | 10/23/2023 |
1.14.1 | 83,916 | 4/4/2023 |
1.14.0 | 4,237 | 3/10/2023 |
1.13.2 | 4,471 | 1/1/2023 |
1.13.1 | 243 | 1/1/2023 |
1.13.0 | 3,708 | 11/18/2022 |
1.12.0-Beta4 | 5,896 | 10/3/2022 |
1.12.0-Beta3 | 222 | 10/2/2022 |
1.12.0-Beta2 | 16 | 10/2/2022 |
1.11.1 | 5,048 | 9/16/2022 |
1.11.0-Beta2 | 7,279 | 8/22/2022 |
1.11.0-Beta1 | 2,345 | 8/16/2022 |
1.10.1 | 18,677 | 7/2/2022 |
1.10.0 | 148 | 7/1/2022 |
1.10.0-Beta3 | 301 | 6/30/2022 |
1.10.0-Beta2 | 56 | 6/30/2022 |
1.10.0-Beta1 | 171 | 6/28/2022 |
1.9.1 | 1,067 | 6/21/2022 |
1.9.1-Beta7 | 15 | 6/21/2022 |
1.9.1-Beta4 | 15 | 6/8/2022 |
1.9.1-Beta3 | 11 | 6/2/2022 |
1.9.1-Beta2 | 12 | 6/2/2022 |
1.9.1-Beta1 | 13 | 3/29/2022 |
1.9.0 | 4,460 | 3/23/2022 |
1.9.0-Beta4 | 111 | 3/23/2022 |
1.9.0-Beta3 | 13 | 3/20/2022 |
1.9.0-Beta2 | 10 | 3/16/2022 |
1.9.0-beta1 | 12 | 3/15/2022 |
1.8.0 | 223 | 3/15/2022 |
1.7.0 | 968 | 2/6/2022 |
1.7.0-Beta1 | 19 | 2/3/2022 |
1.5.0 | 527 | 1/4/2022 |
1.4 | 259 | 11/11/2021 |
1.3.2 | 788 | 10/1/2021 |
1.3.1 | 12 | 10/1/2021 |
1.3.0-Beta5 | 16 | 9/3/2021 |
1.3.0-Beta4 | 12 | 8/25/2021 |
1.3.0-Beta3 | 10 | 8/25/2021 |
1.3.0-Beta2 | 10 | 8/25/2021 |
1.3.0-Beta1 | 10 | 8/25/2021 |
1.2.3 | 42 | 8/24/2021 |
1.2.2 | 12 | 8/24/2021 |
1.2.1 | 68 | 8/23/2021 |
1.2.0 | 19 | 8/22/2021 |
1.1.0 | 337 | 8/12/2021 |
1.0.2 | 33 | 8/11/2021 |
1.0.1 | 17 | 8/10/2021 |