elite42/trackpms

PHP SDK library for Track Pulse API

Maintainers

Details

github.com/elite42consulting/trackpms

Source

Issues

Installs: 72

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 1

Open Issues: 0

v1.9.7 2025-03-20 23:43 UTC

Requires

MIT 5295ba42b0ce7b39f4aebc6aec7666a87b79f0e8

  • Andrew Sauder <andrew.woop@sauder.email>

This package is auto-updated.

Last update: 2025-03-20 23:44:24 UTC

README

**# TRACK Property Management System PHP SDK PHP SDK library for Track Pulse API

This SDK is not created or supported by Track

Requirements

  • Requires Composer for installation
  • Requires >=PHP 8

Installation

composer require elite42/trackpms

Example Usage

$apiSettings = new \elite42\trackpms\trackApiSettings( 
    url          : '{url}',
    key          : '{key}',
    secret       : '{secret}',
    enableCaching: true,
    cachePath    : 'C:/inetpub/cache',
    debugLogging : true,
    debugLogPath : 'C:/inetpub/logs'
);

$api         = new \elite42\trackpms\trackApi( $apiSettings );

try {
    $unit            = $api->getUnit( 145 );
    $unitCollections = $api->getUnitCollections( );
    $units           = $api->getUnits( [ 'size'=>100 ] );

    $reservation            = $api->getReservation( 1 );
    $reservations           = $api->getReservations( [ 'size' => 100 ] );
    $reservationCollections = $api->getReservationCollections( [ 'size' => 100 ] );
    
    $reservationFee = $api->getReservationFee( 1, 2 );
    $reservationFees = $api->getReservationFees( 1 );
    $reservationFeeCollections = $api->getReservationFeeCollections( 1 );
    
    $reservationNote = $api->getReservationNote( 1, 15 );
    $reservationNotes = $api->getReservationNotes( 1 );
    $reservationNoteCollections = $api->getReservationNoteCollections( 1 );
    
    $reservationRates = $api->getReservationRates( 1 );
    
    $amenity = $api->getAmenity( 1 );
    $amenities = $api->getAmenities( [ 'size' => 100 ] );
    $amenityCollections = $api->getAmenityCollections( [ 'size' => 100 ] );
    
    $amenityGroup            = $api->getAmenityGroup( 1 );
    $amenityGroups           = $api->getAmenityGroups( [ 'size' => 100 ] );
    $amenityGroupCollections = $api->getAmenityGroupCollections( [ 'size' => 100 ] );
    
    $customField            = $api->getCustomField( 1 );
    $customFields           = $api->getCustomFields( [ 'size' => 100 ] );
    $customFieldCollections = $api->getCustomFieldCollections( [ 'size' => 100 ] );
	
    $maintenanceWorkOrder            = $api->getMaintenanceWorkOrder( 3 );
    $maintenanceWorkOrders           = $api->getMaintenanceWorkOrders( [ 'size' => 100 ] );
    $maintenanceWorkOrderCollections = $api->getMaintenanceWorkOrderCollections( [ 'size' => 100 ] );
    
    $owner            = $api->getOwner( 1000 );
    $owners           = $api->getOwners( [ 'size' => 100 ] );
    $ownerCollections = $api->getOwnerCollections( [ 'size' => 100 ] );
    $ownerUnits       = $api->getOwnerUnits( 1000 );
    
    $contract            = $api->getContract( 1 );
    $contracts           = $api->getContracts( [ 'size' => 100 ] );
    $contractCollections = $api->getContractCollections( [ 'size' => 100 ] );
    
    $unitRole            = $api->getUnitRole( 1000 );
    $unitRoles           = $api->getUnitRoles( [ 'size' => 100 ] );
    $unitRoleCollections = $api->getUnitRoleCollections( [ 'size' => 100 ] );
    
    $user            = $api->getUser( 1000 );
    $users           = $api->getUsers( [ 'size' => 100 ] );
    $userCollections = $api->getUserCollections( [ 'size' => 100 ] );
    
    
    $role            = $api->getRole( 1000 );
    $roles           = $api->getRoles( [ 'size' => 100 ] );
    $roleCollections = $api->getRoleCollections( [ 'size' => 100 ] );
}
catch( \elite42\trackpms\trackException $e ) {
    throw new controllerException( 'Error while running API command: '.$e->getMessage(), 400, $e);
}

Methods

Units

Fetch API Method
One Unit $api->getUnit( int $unitId )
Many Units $api->getUnits( array $queryParams )
Collection $api->getUnitCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getunits

Unit Pricing

Fetch API Method
Unit Pricing $api->getUnitPricing( int $unitId )

See available query params for $queryParams at https://developer.trackhs.com/reference/getunitpricing

Reservations

Fetch API Method
One Reservation $api->getReservation( int $reservationId )
Many Reservations $api->getReservations( array $queryParams )
Collection $api->getReservationCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getreservations

Reservation Fees

Fetch API Method
One Specific Reservation Fee $api->getReservationFee( int $reservationId, int $reservationFeeId )
All Fees for Reservation $api->getReservationFees( int $reservationId )
Available Fees for Reservation $api->getReservationAvailableFees( int $reservationId )
Collection of Fees for Reservation $api->getReservationFeeCollections( int $reservationId )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getreservationnotes

Reservation Notes

Fetch API Method
One Specific Reservation Note $api->getReservationNote( int $reservationId, int $reservationFeeId )
All Notes for Reservation $api->getReservationNotes( int $reservationId )
Collection of Notes for Reservation $api->getReservationNoteCollections( int $reservationId )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getreservationfees

Reservation Rates

Fetch API Method
Rates for Reservation $api->getReservationRates( int $reservationId )

See https://developer.trackhs.com/reference/getratesreservation

Reservation Types

Fetch API Method
One Reservation Type $api->getReservationType( int $reservationTypeId )
Many Reservation Types $api->getReservationType( array $queryParams )
Collection of Reservation Types $api->getReservationTypeCollections( array $queryParams )
Provides full paged API responses

Not documented by Track API

Unit Blocks

Fetch API Method
One Block $api->getUnitBlock( int $unitBlockId )
Many Blocks $api->getUnitBlocks( array $queryParams )
Collection of Blocks $api->getUnitBlocksCollections( array $queryParams )
Provides full paged API responses

See https://developer.trackhs.com/reference/getunitblock

Amenities

Fetch API Method
One Amenity $api->getAmenity( int $amenityId )
Many Amenities $api->getAmenities( array $queryParams )
Collection $api->getAmenityCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getunitamenities

Amenity Groups

Fetch API Method
One Amenity Group $api->getAmenityGroup( int $amenityGroupId )
Many Amenity Group $api->getAmenityGroups( array $queryParams )
Collection $api->getAmenityGroupCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getunitamenitygroups

Custom Fields

Fetch API Method
One Custom Field $api->getCustomField( int $customFieldId )
Many Custom Fields $api->getCustomFields( array $queryParams )
Collection $api->getCustomFieldCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getcustomfields

Maintenance Work Orders

Fetch API Method
One Work Order $api->getMaintenanceWorkOrder( int $maintenanceWorkOrderId )
Many Work Orders $api->getMaintenanceWorkOrders( array $queryParams )
Collection $api->getMaintenanceWorkOrderCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getmaintworkorders

Housekeeping Work Orders

Fetch API Method
One Work Order $api->getHousekeepingWorkOrder( int $housekeepingWorkOrderId )
Many Work Orders $api->getHousekeepingWorkOrders( array $queryParams )
Collection $api->getHousekeepingWorkOrderCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getworkorders

Owners

Fetch API Method
One Owner $api->getOwner( int $ownerId )
Many Owners $api->getOwners( array $queryParams )
Owner Collection $api->getOwnerCollections( array $queryParams )
Provides full paged API responses
Owner Units $api->getOwnerUnits( int $ownerId )
Provides array of units for the owner

See available query params for $queryParams at https://developer.trackhs.com/reference/getownercollection

Companies (Vendors)

Fetch API Method
One Company $api->getCompany( int $companyId )
Many Companies $api->getCompanies( array $queryParams )
Collection $api->getCompanyCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getcompany

Company (and Owners) Attachments

Fetch API Method
One Attachment for one "company" $api->getCompanyAttachment( int $companyId, int $attachmentId )
Many Attachments for one "company" $api->getCompanyAttachments( int $companyId, array $queryParams )
Attachment Collection for one "company" $api->getCompanyAttachmentCollections( int $companyId, array $queryParams )
Provides full paged API responses
Create Attachment on "Company" $api->createCompanyAttachment( int $companyId, string $fileData, string $name, bool $isPublic, string $originalFilename )
$fileData must be base 64 encoded data
Update Attachment on "Company" $api->updateCompanyAttachment( int $companyId, int $attachmentId, string $name, bool $isPublic )
Delete Attachment on "Company" $api->deleteCompanyAttachment( int $companyId, int $attachmentId )

See available query params for $queryParams at https://developer.trackhs.com/reference/getcompanyattachments

Company (and Owners) Contacts

Fetch API Method
One Contact for one "company" $api->getCompanyContact( int $companyId, int $contactId )
Many Attachments for one "company" $api->getCompanyContacts( int $companyId, array $queryParams )
Attachment Collection for one "company" $api->getCompanyContactCollections( int $companyId, array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getcompanycontacts

Contracts

Fetch API Method
One Contract $api->getContract( int $contractId )
Many Contracts $api->getContracts( array $queryParams )
Collection $api->getContractCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getownercontractcollection

Users

Fetch API Method
One User $api->getUser( int $userId )
Many Users $api->getUsers( array $queryParams )
User Collection $api->getUserCollections( array $queryParams )
Provides full paged API responses

Not documented at Track. See some available $queryParams in an example in this discussion https://developer.trackhs.com/discuss/61fd3729f5da3f029bb47f4c

Roles

Fetch API Method
One Role $api->getRole( int $roleId )
Many Roles $api->getRoles( array $queryParams )
Role Collection $api->getRoleCollections( array $queryParams )
Provides full paged API responses

Not documented by Track API

Unit Roles

Fetch API Method
One Role $api->getUnitRole( int $unitRoleId )
Many Roles $api->getUnitRoles( array $queryParams )
Role Collection $api->getUnitRoleCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getunitrolescollection

Accounting

Items

Fetch API Method
One $api->getAccountingItem( int $itemId )
Many $api->getAccountingItems( array $queryParams )
Collection $api->getAccountingItemCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getitemscollection

Item Categories

Fetch API Method
One $api->getItemCategory( int $categoryId )
Many $api->getItemCategories( array $queryParams )
Collection $api->getItemCategoryCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getitemcateogires

Accounts

Fetch API Method
One $api->getAccount( int $categoryId )
Many $api->getAccounts( array $queryParams )
Collection $api->getAccountCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getledgeraccounts

Transactions

Fetch API Method
One $api->getTransaction( int $transactionId )
Many $api->getTransactions( array $queryParams )
Collection $api->getTransactionCollections( array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getowneridtransactionscollection

Owner Transactions

Fetch API Method
One $api->getOwnerTransaction( int $ownerId, int $ownerTransactionId )
Many $api->getOwnerTransactions( int $ownerId, array $queryParams )
Collection $api->getOwnerTransactionCollections( int $ownerId, array $queryParams )
Provides full paged API responses

See available query params for $queryParams at https://developer.trackhs.com/reference/getowneridtransactionscollection-1

Manual Calls to Track API for methods not implemented

Fetch API Method
Call Once Only $api->call( string $httpMethod, string $apiUrl, array $bodyParams=[] )
Auto Follow Paging $api->callAndFollowPaging( string $httpMethod, string $apiUrl, array $bodyParams=[] )

See available API URLs at https://developer.trackhs.com/reference/ Note that manual calls will not be parsed into models. The function will return the default output of json_decode( $responseBody, false, 512, JSON_THROW_ON_ERROR )**