Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.8 KB

PricingSchedulesApi.md

File metadata and controls

372 lines (249 loc) · 12.8 KB
Raw

Spinen\ConnectWise\Clients\Procurement\PricingSchedulesApi

Spinen's PHP ConnectWise Client for Procurement 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
procurementPricingschedulesCountGet GET /procurement/pricingschedules/count
procurementPricingschedulesGet GET /procurement/pricingschedules
procurementPricingschedulesIdDelete DELETE /procurement/pricingschedules/{id}
procurementPricingschedulesIdGet GET /procurement/pricingschedules/{id}
procurementPricingschedulesIdPatch PATCH /procurement/pricingschedules/{id}
procurementPricingschedulesIdPut PUT /procurement/pricingschedules/{id}
procurementPricingschedulesPost POST /procurement/pricingschedules

procurementPricingschedulesCountGet

\Spinen\ConnectWise\Clients\Procurement\Model\Count procurementPricingschedulesCountGet($conditions)

Get Pricing Schedules Count

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Procurement\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]

procurementPricingschedulesGet

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule[] procurementPricingschedulesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Pricing Schedules

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$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->procurementPricingschedulesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PricingSchedulesApi->procurementPricingschedulesGet: ', $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\Procurement\Model\PricingSchedule[]

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]

procurementPricingschedulesIdDelete

procurementPricingschedulesIdDelete($id)

Delete Pricing Schedule By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$id = 56; // int | 

try {
    $api_instance->procurementPricingschedulesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling PricingSchedulesApi->procurementPricingschedulesIdDelete: ', $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]

procurementPricingschedulesIdGet

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule procurementPricingschedulesIdGet($id)

Get Pricing Schedule By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

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]

procurementPricingschedulesIdPatch

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule procurementPricingschedulesIdPatch($id, $operations)

Update Pricing Schedule

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Procurement\Model\PatchOperation[] | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

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]

procurementPricingschedulesIdPut

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule procurementPricingschedulesIdPut($id, $pricing_schedule)

Replace Pricing Schedule

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$id = 56; // int | 
$pricing_schedule = new \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule(); // \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule | 

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

Parameters

Name Type Description Notes
id int
pricing_schedule \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

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]

procurementPricingschedulesPost

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule procurementPricingschedulesPost($pricing_schedule)

Create Pricing Schedule

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\PricingSchedulesApi();
$pricing_schedule = new \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule(); // \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule | 

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

Parameters

Name Type Description Notes
pricing_schedule \Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\PricingSchedule

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]