PSAspireAPI
1.0
PowerShell module for interacting with the Aspire External API.
Minimum PowerShell version
5.1
Installation Options
Owners
Copyright
Copyright (c) 2025 Site Landscape Development
Package Details
Author(s)
- Brian Dawson
Tags
Functions
Connect-AspireAPI Get-AspireActivities Get-AspireActivityCategories Get-AspireActivityCommentHistories Get-AspireActivityContacts Get-AspireAddresses Get-AspireAPIConnection Get-AspireApiVersion Get-AspireAttachmentFileData Get-AspireAttachments Get-AspireAttachmentsNewLink Get-AspireAttachmentTypes Get-AspireBankDeposits Get-AspireBranches Get-AspireCatalogItemCategories Get-AspireCatalogItems Get-AspireCertifications Get-AspireCertificationTypes Get-AspireClockTimes Get-AspireCompanies Get-AspireContactCustomFieldDefinitions Get-AspireContactCustomFields Get-AspireContactTypes Get-AspireContacts Get-AspireDivisionIntegrationCodes Get-AspireDivisions Get-AspireEmployeeIncidents Get-AspireEmployeeIncidentTypes Get-AspireEquipmentClasses Get-AspireEquipmentDisposalReasons Get-AspireEquipmentManufacturers Get-AspireEquipmentModelServiceSchedules Get-AspireEquipmentModels Get-AspireEquipmentReadingLogs Get-AspireEquipmentRequestedServices Get-AspireEquipmentServiceLogs Get-AspireEquipmentServiceTags Get-AspireEquipmentSizes Get-AspireEquipments Get-AspireInventoryLocations Get-AspireInvoiceBatches Get-AspireInvoiceRevenues Get-AspireInvoiceTaxes Get-AspireInvoices Get-AspireItemAllocations Get-AspireLocalities Get-AspireObjectCodes Get-AspireOpportunities Get-AspireOpportunityLostReasons Get-AspireOpportunityServiceGroups Get-AspireOpportunityServiceItems Get-AspireOpportunityServiceKitItems Get-AspireOpportunityServices Get-AspireOpportunityStatuses Get-AspireOpportunityTags Get-AspirePayCodes Get-AspirePayRateOverridePayCodes Get-AspirePayRates Get-AspirePaySchedules Get-AspirePaymentCategories Get-AspirePaymentTerms Get-AspirePayments Get-AspirePropertyAvailabilities Get-AspirePropertyContacts Get-AspirePropertyCustomFieldDefinitions Get-AspirePropertyCustomFields Get-AspirePropertyGroups Get-AspirePropertyStatuses Get-AspirePropertyTypes Get-AspireProspectRatings Get-AspireReceipts Get-AspireReceiptStatuses Get-AspireRegions Get-AspireRevenueVariances Get-AspireRoles Get-AspireRoutes Get-AspireSalesTypes Get-AspireServices Get-AspireServiceTypes Get-AspireServiceTypeIntegrationCodes Get-AspireTags Get-AspireTakeoffGroups Get-AspireTakeoffItems Get-AspireTasks Get-AspireTaxEntities Get-AspireTaxJurisdictions Get-AspireUnitTypes Get-AspireUsers Get-AspireVendors Get-AspireWorkersComps Get-AspireWorkTicketCanceledReasons Get-AspireWorkTicketItems Get-AspireWorkTicketRevenues Get-AspireWorkTicketStatus Get-AspireWorkTickets Get-AspireWorkTicketTimes Get-AspireWorkTicketVisitNotes Get-AspireWorkTicketVisits Invoke-AspireReceiptApprove Invoke-AspireReceiptReceive New-AspireCatalogItem New-AspireClockTime New-AspireCompany New-AspireContact New-AspireContactCustomField New-AspireEquipmentReadingLog New-AspireIssue New-AspireItemAllocation New-AspireLocality New-AspireOpportunity New-AspireOpportunityLostReason New-AspireOpportunityTag New-AspirePartialPayment New-AspirePayCode New-AspirePayRate New-AspirePayRateOverridePayCode New-AspirePaySchedule New-AspireProperty New-AspirePropertyAvailability New-AspirePropertyContact New-AspirePropertyCustomField New-AspireReceipt New-AspireServiceTaxOverride New-AspireTasks New-AspireTaxEntities New-AspireTaxJurisdictions New-AspireUnitTypes New-AspireUsers New-AspireVendors New-AspireWorkersComps New-AspireWorkTicketStatusMarkWorkTicketAsReviewed New-AspireWorkTicketTimes New-AspireWorkTicketsCreateAsNeededWorkTickets Remove-AspireOpportunityTag Update-AspireCatalogItem Update-AspireCompany Update-AspireContact Update-AspireContactCustomField Update-AspireEquipmentReadingLog Update-AspireItemAllocation Update-AspireLocality Update-AspireOpportunityLostReason Update-AspirePayRate Update-AspirePayRateOverridePayCode Update-AspirePaySchedule Update-AspireProperty Update-AspirePropertyContact Update-AspirePropertyCustomField Update-AspireServiceTaxOverride Update-AspireTaxEntities Update-AspireTaxJurisdictions Update-AspireUnitTypes Update-AspireUsers Update-AspireVendors Update-AspireWorkersComps
Dependencies
This module has no dependencies.
Release Notes
Initial release.
FileList
- PSAspireAPI.nuspec
- LICENSE
- Public\ActivityCommentHistories\Get-AspireActivityCommentHistories.ps1
- Public\Authorization\Connect-AspireAPI.ps1
- Public\Certifications\Get-AspireCertifications.ps1
- Public\ContactCustomFields\Get-AspireContactCustomFields.ps1
- Public\Divisions\Get-AspireDivisions.ps1
- Public\EquipmentReadingLogs\Get-AspireEquipmentReadingLogs.ps1
- Public\InventoryLocations\Get-AspireInventoryLocations.ps1
- Public\ItemAllocations\Update-AspireItemAllocation.ps1
- Public\Opportunities\Get-AspireOpportunityServiceKitItems.ps1
- Public\OpportunityServiceItems\Get-AspireOpportunityServiceItems.ps1
- Public\PayCodes\Get-AspirePayCodes.ps1
- Public\PayRateOverridePayCodes\Update-AspirePayRateOverridePayCode.ps1
- Public\Properties\New-AspireProperty.ps1
- Public\PropertyCustomFieldDefinitions\Get-AspirePropertyCustomFieldDefinitions.ps1
- Public\ProspectRatings\Get-AspireProspectRatings.ps1
- Public\RevenueVariances\Get-AspireRevenueVariances.ps1
- Public\ServiceTypeIntegrationCodes\Get-AspireServiceTypeIntegrationCodes.ps1
- Public\TaxEntities\New-AspireTaxEntities.ps1
- Public\UnitTypes\Update-AspireUnitTypes.ps1
- Public\Version\Get-AspireApiVersion.ps1
- Public\WorkTickets\Get-AspireWorkTickets.ps1
- Public\ActivityContacts\Get-AspireActivityContacts.ps1
- Public\Authorization\Get-AspireAPIConnection.ps1
- Public\CertificationTypes\Get-AspireCertificationTypes.ps1
- Public\ContactCustomFields\New-AspireContactCustomField.ps1
- Public\EmployeeIncidents\Get-AspireEmployeeIncidents.ps1
- Public\EquipmentReadingLogs\New-AspireEquipmentReadingLog.ps1
- Public\InvoiceBatches\Get-AspireInvoiceBatches.ps1
- Public\Localities\Get-AspireLocalities.ps1
- Public\Opportunities\Get-AspireOpportunityServices.ps1
- Public\OpportunityServiceKitItems\Get-AspireOpportunityServiceKitItems.ps1
- Public\PayCodes\New-AspirePayCode.ps1
- Public\PayRates\Get-AspirePayRates.ps1
- Public\Properties\Update-AspireProperty.ps1
- Public\PropertyCustomFields\Get-AspirePropertyCustomFields.ps1
- Public\Receipts\Get-AspireReceipts.ps1
- Public\Roles\Get-AspireRoles.ps1
- Public\ServiceTypes\Get-AspireServiceTypes.ps1
- Public\TaxEntities\Update-AspireTaxEntities.ps1
- Public\Users\Get-AspireUsers.ps1
- Public\WorkersComps\Get-AspireWorkersComps.ps1
- Public\WorkTickets\New-AspireWorkTicketsCreateAsNeededWorkTickets.ps1
- PSAspireAPI.psd1
- Public\Addresses\Get-AspireAddresses.ps1
- Public\BankDeposits\Get-AspireBankDeposits.ps1
- Public\ClockTimes\Get-AspireClockTimes.ps1
- Public\ContactCustomFields\Update-AspireContactCustomField.ps1
- Public\EmployeeIncidentTypes\Get-AspireEmployeeIncidentTypes.ps1
- Public\EquipmentReadingLogs\Update-AspireEquipmentReadingLog.ps1
- Public\InvoiceRevenues\Get-AspireInvoiceRevenues.ps1
- Public\Localities\New-AspireLocality.ps1
- Public\Opportunities\Get-AspireOpportunityStatuses.ps1
- Public\OpportunityServices\Get-AspireOpportunityServices.ps1
- Public\PayCodes\Update-AspirePayCode.ps1
- Public\PayRates\New-AspirePayRate.ps1
- Public\PropertyAvailabilities\Get-AspirePropertyAvailabilities.ps1
- Public\PropertyCustomFields\New-AspirePropertyCustomField.ps1
- Public\Receipts\Invoke-AspireReceiptApprove.ps1
- Public\Routes\Get-AspireRoutes.ps1
- Public\Tags\Get-AspireTags.ps1
- Public\TaxJurisdictions\Get-AspireTaxJurisdictions.ps1
- Public\Users\New-AspireUsers.ps1
- Public\WorkersComps\New-AspireWorkersComps.ps1
- Public\WorkTicketStatus\New-AspireWorkTicketStatusMarkWorkTicketAsReviewed.ps1
- PSAspireAPI.psm1
- Public\Attachments\Get-AspireAttachmentFileData.ps1
- Public\Branches\Get-AspireBranches.ps1
- Public\ClockTimes\New-AspireClockTime.ps1
- Public\Contacts\Get-AspireContacts.ps1
- Public\EquipmentClasses\Get-AspireEquipmentClasses.ps1
- Public\EquipmentRequestedServices\Get-AspireEquipmentRequestedServices.ps1
- Public\Invoices\Get-AspireInvoices.ps1
- Public\Localities\Update-AspireLocality.ps1
- Public\Opportunities\New-AspireOpportunity.ps1
- Public\OpportunityStatuses\Get-AspireOpportunityStatuses.ps1
- Public\PaymentCategories\Get-AspirePaymentCategories.ps1
- Public\PayRates\Update-AspirePayRate.ps1
- Public\PropertyAvailabilities\New-AspirePropertyAvailability.ps1
- Public\PropertyCustomFields\Update-AspirePropertyCustomField.ps1
- Public\Receipts\Invoke-AspireReceiptReceive.ps1
- Public\SalesTypes\Get-AspireSalesTypes.ps1
- Public\TakeoffGroups\Get-AspireTakeoffGroups.ps1
- Public\TaxJurisdictions\New-AspireTaxJurisdictions.ps1
- Public\Users\Update-AspireUsers.ps1
- Public\WorkersComps\Update-AspireWorkersComps.ps1
- Public\WorkTicketTimes\Get-AspireWorkTicketTimes.ps1
- README.md
- Public\Attachments\Get-AspireAttachmentNewLink.ps1
- Public\CatalogItemCategories\Get-AspireCatalogItemCategories.ps1
- Public\Companies\Get-AspireCompanies.ps1
- Public\Contacts\New-AspireContact.ps1
- Public\EquipmentDisposalReasons\Get-AspireEquipmentDisposalReasons.ps1
- Public\Equipments\Get-AspireEquipments.ps1
- Public\InvoiceTaxes\Get-AspireInvoiceTaxes.ps1
- Public\ObjectCodes\Get-AspireObjectCodes.ps1
- Public\OpportunityLostReasons\Get-AspireOpportunityLostReasons.ps1
- Public\OpportunityTags\Get-AspireOpportunityTags.ps1
- Public\Payments\Get-AspirePayments.ps1
- Public\PaySchedules\Get-AspirePaySchedules.ps1
- Public\PropertyContacts\Get-AspirePropertyContacts.ps1
- Public\PropertyGroups\Get-AspirePropertyGroups.ps1
- Public\Receipts\New-AspireReceipt.ps1
- Public\Services\Get-AspireServices.ps1
- Public\TakeoffItems\Get-AspireTakeoffItems.ps1
- Public\TaxJurisdictions\Update-AspireTaxJurisdictions.ps1
- Public\Vendors\Get-AspireVendors.ps1
- Public\WorkTicketCanceledReasons\Get-AspireWorkTicketCanceledReasons.ps1
- Public\WorkTicketTimes\New-AspireWorkTicketTimes.ps1
- Private\Invoke\Invoke-AspireRequest.ps1
- Public\Attachments\Get-AspireAttachments.ps1
- Public\CatalogItems\Get-AspireCatalogItems.ps1
- Public\Companies\New-AspireCompany.ps1
- Public\Contacts\Update-AspireContact.ps1
- Public\EquipmentManufacturers\Get-AspireEquipmentManufacturers.ps1
- Public\EquipmentServiceLogs\Get-AspireEquipmentServiceLogs.ps1
- Public\Issues\New-AspireIssue.ps1
- Public\Opportunities\Get-AspireOpportunities.ps1
- Public\OpportunityLostReasons\New-AspireOpportunityLostReason.ps1
- Public\OpportunityTags\New-AspireOpportunityTag.ps1
- Public\PaymentTerms\Get-AspirePaymentTerms.ps1
- Public\PaySchedules\New-AspirePaySchedule.ps1
- Public\PropertyContacts\New-AspirePropertyContact.ps1
- Public\PropertyStatuses\Get-AspirePropertyStatuses.ps1
- Public\ReceiptStatuses\Get-AspireReceiptStatuses.ps1
- Public\ServiceTaxOverrides\New-AspireServiceTaxOverride.ps1
- Public\Tasks\New-AspireTasks.ps1
- Public\UnitTypes\Get-AspireUnitTypes.ps1
- Public\Vendors\New-AspireVendors.ps1
- Public\WorkTicketItems\Get-AspireWorkTicketItems.ps1
- Public\WorkTicketVisitNotes\Get-AspireWorkTicketVisitNotes.ps1
- Public\Activities\Get-AspireActivities.ps1
- Public\Attachments\New-AspireAttachment.ps1
- Public\CatalogItems\New-AspireCatalogItem.ps1
- Public\Companies\Update-AspireCompany.ps1
- Public\ContactTypes\Get-AspireContactTypes.ps1
- Public\EquipmentModels\Get-AspireEquipmentModels.ps1
- Public\EquipmentServiceTags\Get-AspireEquipmentServiceTags.ps1
- Public\ItemAllocations\Get-AspireItemAllocations.ps1
- Public\Opportunities\Get-AspireOpportunityServiceGroups.ps1
- Public\OpportunityLostReasons\Update-AspireOpportunityLostReason.ps1
- Public\OpportunityTags\Remove-AspireOpportunityTag.ps1
- Public\PayRateOverridePayCodes\Get-AspirePayRateOverridePayCodes.ps1
- Public\PaySchedules\Update-AspirePaySchedule.ps1
- Public\PropertyContacts\Update-AspirePropertyContact.ps1
- Public\PropertyTypes\Get-AspirePropertyTypes.ps1
- Public\Regions\Get-AspireRegions.ps1
- Public\ServiceTaxOverrides\Update-AspireServiceTaxOverride.ps1
- Public\TaxEntities\Get-AspireTaxEntities.ps1
- Public\UnitTypes\New-AspireUnitTypes.ps1
- Public\Vendors\Update-AspireVendors.ps1
- Public\WorkTicketRevenues\Get-AspireWorkTicketRevenues.ps1
- Public\WorkTicketVisits\Get-AspireWorkTicketVisits.ps1
- Public\ActivityCategories\Get-AspireActivityCategories.ps1
- Public\AttachmentTypes\Get-AttachmentTypes.ps1
- Public\CatalogItems\Update-AspireCatalogItem.ps1
- Public\ContactCustomFieldDefinitions\Get-AspireContactCustomFieldDefinitions.ps1
- Public\DivisionIntegrationCodes\Get-AspireDivisionIntegrationCodes.ps1
- Public\EquipmentModelServiceSchedules\Get-AspireEquipmentModelServiceSchedules.ps1
- Public\EquipmentSizes\Get-AspireEquipmentSizes.ps1
- Public\ItemAllocations\New-AspireItemAllocation.ps1
- Public\Opportunities\Get-AspireOpportunityServiceItems.ps1
- Public\OpportunityServiceGroups\Get-AspireOpportunityServiceGroups.ps1
- Public\PartialPayments\New-AspirePartialPayment.ps1
- Public\PayRateOverridePayCodes\New-AspirePayRateOverridePayCode.ps1
- Public\Properties\Get-AspireProperties.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 1.0 (current version) | 132 | 9/13/2025 |