spinen / connectwise-sales-php-client
Spinen's PHP ConnectWise Client for Sales API generated by Swagger Code Generator.
Installs: 10
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/spinen/connectwise-sales-php-client
Requires
- php: >=5.6
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~1.0
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2025-10-22 04:00:19 UTC
README
ConnectWise Sales API
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 3.0.0-beta
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.6.0 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json:
composer require spinen/connectwise-sales-php-client
Or modify your composer.json file:
{
"require": {
"spinen/connectwise-sales-php-client": "^3.0.0-beta"
}
}
Manual Installation
Download the files and include autoload.php:
require_once('/path/to/connectwise-sales-php-client/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: BasicAuth Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME'); Spinen\ConnectWise\Clients\Sales\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD'); $api_instance = new Spinen\ConnectWise\Clients\Sales\Api\ActivitiesApi(); $conditions = "conditions_example"; // string | $custom_field_conditions = "custom_field_conditions_example"; // string | try { $result = $api_instance->salesActivitiesCountGet($conditions, $custom_field_conditions); print_r($result); } catch (Exception $e) { echo 'Exception when calling ActivitiesApi->salesActivitiesCountGet: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivitiesApi | salesActivitiesCountGet | GET /sales/activities/count | |
| ActivitiesApi | salesActivitiesGet | GET /sales/activities | |
| ActivitiesApi | salesActivitiesIdDelete | DELETE /sales/activities/{id} | |
| ActivitiesApi | salesActivitiesIdGet | GET /sales/activities/{id} | |
| ActivitiesApi | salesActivitiesIdPatch | PATCH /sales/activities/{id} | |
| ActivitiesApi | salesActivitiesIdPut | PUT /sales/activities/{id} | |
| ActivitiesApi | salesActivitiesPost | POST /sales/activities | |
| ActivityStatusesApi | salesActivitiesStatusesCountGet | GET /sales/activities/statuses/count | |
| ActivityStatusesApi | salesActivitiesStatusesGet | GET /sales/activities/statuses | |
| ActivityStatusesApi | salesActivitiesStatusesIdDelete | DELETE /sales/activities/statuses/{id} | |
| ActivityStatusesApi | salesActivitiesStatusesIdGet | GET /sales/activities/statuses/{id} | |
| ActivityStatusesApi | salesActivitiesStatusesIdPatch | PATCH /sales/activities/statuses/{id} | |
| ActivityStatusesApi | salesActivitiesStatusesIdPut | PUT /sales/activities/statuses/{id} | |
| ActivityStatusesApi | salesActivitiesStatusesPost | POST /sales/activities/statuses | |
| ActivityTypesApi | salesActivitiesTypesCountGet | GET /sales/activities/types/count | |
| ActivityTypesApi | salesActivitiesTypesGet | GET /sales/activities/types | |
| ActivityTypesApi | salesActivitiesTypesIdDelete | DELETE /sales/activities/types/{id} | |
| ActivityTypesApi | salesActivitiesTypesIdGet | GET /sales/activities/types/{id} | |
| ActivityTypesApi | salesActivitiesTypesIdPatch | PATCH /sales/activities/types/{id} | |
| ActivityTypesApi | salesActivitiesTypesIdPut | PUT /sales/activities/types/{id} | |
| ActivityTypesApi | salesActivitiesTypesPost | POST /sales/activities/types | |
| OpportunitiesApi | salesOpportunitiesCountGet | GET /sales/opportunities/count | |
| OpportunitiesApi | salesOpportunitiesGet | GET /sales/opportunities | |
| OpportunitiesApi | salesOpportunitiesIdConvertToAgreementPost | POST /sales/opportunities/{id}/convertToAgreement | |
| OpportunitiesApi | salesOpportunitiesIdConvertToProjectPost | POST /sales/opportunities/{id}/convertToProject | |
| OpportunitiesApi | salesOpportunitiesIdConvertToSalesOrderPost | POST /sales/opportunities/{id}/convertToSalesOrder | |
| OpportunitiesApi | salesOpportunitiesIdConvertToServiceTicketPost | POST /sales/opportunities/{id}/convertToServiceTicket | |
| OpportunitiesApi | salesOpportunitiesIdDelete | DELETE /sales/opportunities/{id} | |
| OpportunitiesApi | salesOpportunitiesIdGet | GET /sales/opportunities/{id} | |
| OpportunitiesApi | salesOpportunitiesIdPatch | PATCH /sales/opportunities/{id} | |
| OpportunitiesApi | salesOpportunitiesIdPut | PUT /sales/opportunities/{id} | |
| OpportunitiesApi | salesOpportunitiesPost | POST /sales/opportunities | |
| OpportunityContactsApi | salesOpportunitiesIdContactsContactIdDelete | DELETE /sales/opportunities/{id}/contacts/{contactId} | |
| OpportunityContactsApi | salesOpportunitiesIdContactsContactIdGet | GET /sales/opportunities/{id}/contacts/{contactId} | |
| OpportunityContactsApi | salesOpportunitiesIdContactsContactIdPatch | PATCH /sales/opportunities/{id}/contacts/{contactId} | |
| OpportunityContactsApi | salesOpportunitiesIdContactsContactIdPut | PUT /sales/opportunities/{id}/contacts/{contactId} | |
| OpportunityContactsApi | salesOpportunitiesIdContactsCountGet | GET /sales/opportunities/{id}/contacts/count | |
| OpportunityContactsApi | salesOpportunitiesIdContactsGet | GET /sales/opportunities/{id}/contacts | |
| OpportunityContactsApi | salesOpportunitiesIdContactsPost | POST /sales/opportunities/{id}/contacts | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastCountGet | GET /sales/opportunities/{id}/forecast/count | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastForecastIdDelete | DELETE /sales/opportunities/{id}/forecast/{forecastId} | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastForecastIdGet | GET /sales/opportunities/{id}/forecast/{forecastId} | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastForecastIdPatch | PATCH /sales/opportunities/{id}/forecast/{forecastId} | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastForecastIdPut | PUT /sales/opportunities/{id}/forecast/{forecastId} | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastGet | GET /sales/opportunities/{id}/forecast | |
| OpportunityForecastsApi | salesOpportunitiesIdForecastPost | POST /sales/opportunities/{id}/forecast | |
| OpportunityNotesApi | salesOpportunitiesIdNotesCountGet | GET /sales/opportunities/{id}/notes/count | |
| OpportunityNotesApi | salesOpportunitiesIdNotesGet | GET /sales/opportunities/{id}/notes | |
| OpportunityNotesApi | salesOpportunitiesIdNotesNoteIdDelete | DELETE /sales/opportunities/{id}/notes/{noteId} | |
| OpportunityNotesApi | salesOpportunitiesIdNotesNoteIdGet | GET /sales/opportunities/{id}/notes/{noteId} | |
| OpportunityNotesApi | salesOpportunitiesIdNotesNoteIdPatch | PATCH /sales/opportunities/{id}/notes/{noteId} | |
| OpportunityNotesApi | salesOpportunitiesIdNotesNoteIdPut | PUT /sales/opportunities/{id}/notes/{noteId} | |
| OpportunityNotesApi | salesOpportunitiesIdNotesPost | POST /sales/opportunities/{id}/notes | |
| OpportunityRatingsApi | salesOpportunitiesRatingsCountGet | GET /sales/opportunities/ratings/count | |
| OpportunityRatingsApi | salesOpportunitiesRatingsGet | GET /sales/opportunities/ratings | |
| OpportunityRatingsApi | salesOpportunitiesRatingsIdDelete | DELETE /sales/opportunities/ratings/{id} | |
| OpportunityRatingsApi | salesOpportunitiesRatingsIdGet | GET /sales/opportunities/ratings/{id} | |
| OpportunityRatingsApi | salesOpportunitiesRatingsIdPatch | PATCH /sales/opportunities/ratings/{id} | |
| OpportunityRatingsApi | salesOpportunitiesRatingsIdPut | PUT /sales/opportunities/ratings/{id} | |
| OpportunityRatingsApi | salesOpportunitiesRatingsPost | POST /sales/opportunities/ratings | |
| OpportunityStagesApi | salesStagesCountGet | GET /sales/stages/count | |
| OpportunityStagesApi | salesStagesGet | GET /sales/stages | |
| OpportunityStagesApi | salesStagesIdDelete | DELETE /sales/stages/{id} | |
| OpportunityStagesApi | salesStagesIdGet | GET /sales/stages/{id} | |
| OpportunityStagesApi | salesStagesIdPatch | PATCH /sales/stages/{id} | |
| OpportunityStagesApi | salesStagesIdPut | PUT /sales/stages/{id} | |
| OpportunityStagesApi | salesStagesPost | POST /sales/stages | |
| OpportunityStatusesApi | salesOpportunitiesStatusesCountGet | GET /sales/opportunities/statuses/count | |
| OpportunityStatusesApi | salesOpportunitiesStatusesGet | GET /sales/opportunities/statuses | |
| OpportunityStatusesApi | salesOpportunitiesStatusesIdDelete | DELETE /sales/opportunities/statuses/{id} | |
| OpportunityStatusesApi | salesOpportunitiesStatusesIdGet | GET /sales/opportunities/statuses/{id} | |
| OpportunityStatusesApi | salesOpportunitiesStatusesIdPatch | PATCH /sales/opportunities/statuses/{id} | |
| OpportunityStatusesApi | salesOpportunitiesStatusesIdPut | PUT /sales/opportunities/statuses/{id} | |
| OpportunityStatusesApi | salesOpportunitiesStatusesPost | POST /sales/opportunities/statuses | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamCountGet | GET /sales/opportunities/{id}/team/count | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamGet | GET /sales/opportunities/{id}/team | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamPost | POST /sales/opportunities/{id}/team | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamTeamIdDelete | DELETE /sales/opportunities/{id}/team/{teamId} | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamTeamIdGet | GET /sales/opportunities/{id}/team/{teamId} | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamTeamIdPatch | PATCH /sales/opportunities/{id}/team/{teamId} | |
| OpportunityTeamsApi | salesOpportunitiesIdTeamTeamIdPut | PUT /sales/opportunities/{id}/team/{teamId} | |
| OpportunityTypesApi | salesOpportunitiesTypesCountGet | GET /sales/opportunities/types/count | |
| OpportunityTypesApi | salesOpportunitiesTypesGet | GET /sales/opportunities/types | |
| OpportunityTypesApi | salesOpportunitiesTypesIdDelete | DELETE /sales/opportunities/types/{id} | |
| OpportunityTypesApi | salesOpportunitiesTypesIdGet | GET /sales/opportunities/types/{id} | |
| OpportunityTypesApi | salesOpportunitiesTypesIdPatch | PATCH /sales/opportunities/types/{id} | |
| OpportunityTypesApi | salesOpportunitiesTypesIdPut | PUT /sales/opportunities/types/{id} | |
| OpportunityTypesApi | salesOpportunitiesTypesPost | POST /sales/opportunities/types | |
| OrderStatusesApi | salesOrdersStatusesCountGet | GET /sales/orders/statuses/count | |
| OrderStatusesApi | salesOrdersStatusesGet | GET /sales/orders/statuses | |
| OrderStatusesApi | salesOrdersStatusesIdDelete | DELETE /sales/orders/statuses/{id} | |
| OrderStatusesApi | salesOrdersStatusesIdGet | GET /sales/orders/statuses/{id} | |
| OrderStatusesApi | salesOrdersStatusesIdPatch | PATCH /sales/orders/statuses/{id} | |
| OrderStatusesApi | salesOrdersStatusesIdPut | PUT /sales/orders/statuses/{id} | |
| OrderStatusesApi | salesOrdersStatusesPost | POST /sales/orders/statuses | |
| OrdersApi | salesOrdersCountGet | GET /sales/orders/count | |
| OrdersApi | salesOrdersGet | GET /sales/orders | |
| OrdersApi | salesOrdersIdDelete | DELETE /sales/orders/{id} | |
| OrdersApi | salesOrdersIdGet | GET /sales/orders/{id} | |
| OrdersApi | salesOrdersIdPatch | PATCH /sales/orders/{id} | |
| OrdersApi | salesOrdersIdPut | PUT /sales/orders/{id} | |
| OrdersApi | salesOrdersPost | POST /sales/orders | |
| RolesApi | salesRolesCountGet | GET /sales/roles/count | |
| RolesApi | salesRolesGet | GET /sales/roles | |
| RolesApi | salesRolesIdDelete | DELETE /sales/roles/{id} | |
| RolesApi | salesRolesIdGet | GET /sales/roles/{id} | |
| RolesApi | salesRolesIdPatch | PATCH /sales/roles/{id} | |
| RolesApi | salesRolesIdPut | PUT /sales/roles/{id} | |
| RolesApi | salesRolesPost | POST /sales/roles | |
| SalesProbabilitiesApi | salesProbabilitiesCountGet | GET /sales/probabilities/count | |
| SalesProbabilitiesApi | salesProbabilitiesGet | GET /sales/probabilities | |
| SalesProbabilitiesApi | salesProbabilitiesIdDelete | DELETE /sales/probabilities/{id} | |
| SalesProbabilitiesApi | salesProbabilitiesIdGet | GET /sales/probabilities/{id} | |
| SalesProbabilitiesApi | salesProbabilitiesIdPatch | PATCH /sales/probabilities/{id} | |
| SalesProbabilitiesApi | salesProbabilitiesIdPut | PUT /sales/probabilities/{id} | |
| SalesProbabilitiesApi | salesProbabilitiesPost | POST /sales/probabilities |
Documentation For Models
- Activity
- ActivityStatus
- ActivityStatusReference
- ActivityType
- ActivityTypeReference
- Agreement
- AgreementReference
- AgreementTypeReference
- BillingTermsReference
- BoardReference
- CampaignReference
- CompanyReference
- ContactReference
- Count
- CountryReference
- CustomFieldValue
- Error
- Forecast
- Guid
- MemberReference
- Metadata
- NoteTypeReference
- Opportunity
- OpportunityContact
- OpportunityNote
- OpportunityPriorityReference
- OpportunityProbabilityReference
- OpportunityRating
- OpportunityRatingReference
- OpportunityReference
- OpportunitySalesRoleReference
- OpportunityStage
- OpportunityStageReference
- OpportunityStatus
- OpportunityStatusReference
- OpportunityToAgreementConversion
- OpportunityToProjectConversion
- OpportunityToSalesOrderConversion
- OpportunityToServiceTicketConversion
- OpportunityType
- OpportunityTypeReference
- Order
- OrderStatus
- OrderStatusReference
- PatchOperation
- PriorityReference
- ProductRecurring
- Project
- ProjectBoardReference
- ProjectPhaseReference
- ProjectReference
- ProjectStatusReference
- ProjectTypeReference
- ReminderReference
- Role
- SLAReference
- SalesProbability
- SalesTeamReference
- ScheduleStatusReference
- ServiceItemReference
- ServiceLocationReference
- ServiceSourceReference
- ServiceStatusReference
- ServiceSubTypeReference
- ServiceTeamReference
- ServiceTypeReference
- SiteReference
- TaxCodeReference
- Team
- Ticket
- TicketReference
- ValidationError
- WorkRoleReference
- WorkTypeReference
Documentation For Authorization
BasicAuth
- Type: HTTP basic authentication