Skip to content

Latest commit

 

History

History
582 lines (391 loc) · 20 KB

OpportunitiesApi.md

File metadata and controls

582 lines (391 loc) · 20 KB
Raw

Spinen\ConnectWise\Clients\Sales\OpportunitiesApi

Spinen's PHP ConnectWise Client for Sales API generated by Swagger Code Generator.

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
salesOpportunitiesCountGet GET /sales/opportunities/count
salesOpportunitiesGet GET /sales/opportunities
salesOpportunitiesIdConvertToAgreementPost POST /sales/opportunities/{id}/convertToAgreement
salesOpportunitiesIdConvertToProjectPost POST /sales/opportunities/{id}/convertToProject
salesOpportunitiesIdConvertToSalesOrderPost POST /sales/opportunities/{id}/convertToSalesOrder
salesOpportunitiesIdConvertToServiceTicketPost POST /sales/opportunities/{id}/convertToServiceTicket
salesOpportunitiesIdDelete DELETE /sales/opportunities/{id}
salesOpportunitiesIdGet GET /sales/opportunities/{id}
salesOpportunitiesIdPatch PATCH /sales/opportunities/{id}
salesOpportunitiesIdPut PUT /sales/opportunities/{id}
salesOpportunitiesPost POST /sales/opportunities

salesOpportunitiesCountGet

\Spinen\ConnectWise\Clients\Sales\Model\Count salesOpportunitiesCountGet($conditions, $custom_field_conditions)

Get Opportunities Count

Example

<?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\OpportunitiesApi();
$conditions = "conditions_example"; // string | 
$custom_field_conditions = "custom_field_conditions_example"; // string | 

try {
    $result = $api_instance->salesOpportunitiesCountGet($conditions, $custom_field_conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesCountGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
conditions string [optional]
custom_field_conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Count

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesGet

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity[] salesOpportunitiesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Opportunities

Example

<?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\OpportunitiesApi();
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->salesOpportunitiesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
conditions string [optional]
order_by string [optional]
childconditions string [optional]
customfieldconditions string [optional]
page int [optional]
page_size int [optional]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity[]

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdConvertToAgreementPost

\Spinen\ConnectWise\Clients\Sales\Model\Agreement salesOpportunitiesIdConvertToAgreementPost($id, $conversion)

Convert Opportunity To Agreement

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$conversion = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToAgreementConversion(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToAgreementConversion | 

try {
    $result = $api_instance->salesOpportunitiesIdConvertToAgreementPost($id, $conversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdConvertToAgreementPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conversion \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToAgreementConversion

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Agreement

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdConvertToProjectPost

\Spinen\ConnectWise\Clients\Sales\Model\Project salesOpportunitiesIdConvertToProjectPost($id, $conversion)

Convert Opportunity To Project

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$conversion = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToProjectConversion(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToProjectConversion | 

try {
    $result = $api_instance->salesOpportunitiesIdConvertToProjectPost($id, $conversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdConvertToProjectPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conversion \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToProjectConversion

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Project

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdConvertToSalesOrderPost

\Spinen\ConnectWise\Clients\Sales\Model\Order salesOpportunitiesIdConvertToSalesOrderPost($id, $conversion)

Convert Opportunity To Sales Order

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$conversion = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToSalesOrderConversion(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToSalesOrderConversion | 

try {
    $result = $api_instance->salesOpportunitiesIdConvertToSalesOrderPost($id, $conversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdConvertToSalesOrderPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conversion \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToSalesOrderConversion

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Order

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdConvertToServiceTicketPost

\Spinen\ConnectWise\Clients\Sales\Model\Ticket salesOpportunitiesIdConvertToServiceTicketPost($id, $conversion)

Convert Opportunity To Service Ticket

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$conversion = new \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToServiceTicketConversion(); // \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToServiceTicketConversion | 

try {
    $result = $api_instance->salesOpportunitiesIdConvertToServiceTicketPost($id, $conversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdConvertToServiceTicketPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conversion \Spinen\ConnectWise\Clients\Sales\Model\OpportunityToServiceTicketConversion

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Ticket

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdDelete

salesOpportunitiesIdDelete($id)

Delete Opportunity By Id

Example

<?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\OpportunitiesApi();
$id = 56; // int | 

try {
    $api_instance->salesOpportunitiesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdGet

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity salesOpportunitiesIdGet($id)

Get Opportunity By Id

Example

<?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\OpportunitiesApi();
$id = 56; // int | 

try {
    $result = $api_instance->salesOpportunitiesIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdPatch

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity salesOpportunitiesIdPatch($id, $operations)

Update Opportunity

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Sales\Model\PatchOperation[] | 

try {
    $result = $api_instance->salesOpportunitiesIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
operations \Spinen\ConnectWise\Clients\Sales\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesIdPut

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity salesOpportunitiesIdPut($id, $opportunity)

Replace Opportunity

Example

<?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\OpportunitiesApi();
$id = 56; // int | 
$opportunity = new \Spinen\ConnectWise\Clients\Sales\Model\Opportunity(); // \Spinen\ConnectWise\Clients\Sales\Model\Opportunity | 

try {
    $result = $api_instance->salesOpportunitiesIdPut($id, $opportunity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
opportunity \Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

salesOpportunitiesPost

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity salesOpportunitiesPost($opportunity)

Create Opportunity

Example

<?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\OpportunitiesApi();
$opportunity = new \Spinen\ConnectWise\Clients\Sales\Model\Opportunity(); // \Spinen\ConnectWise\Clients\Sales\Model\Opportunity | 

try {
    $result = $api_instance->salesOpportunitiesPost($opportunity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->salesOpportunitiesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
opportunity \Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Return type

\Spinen\ConnectWise\Clients\Sales\Model\Opportunity

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]