Skip to content

Latest commit

 

History

History
315 lines (217 loc) · 12.6 KB

SalesEstimatesApi.md

File metadata and controls

315 lines (217 loc) · 12.6 KB

SynergiTech\Sage\SalesEstimatesApi

All URIs are relative to https://api.accounting.sage.com/v3.1, except if the operation defines another base path.

Method HTTP request Description
deleteSalesEstimatesKey() DELETE /sales_estimates/{key} Deletes a Sales Estimate
getSalesEstimates() GET /sales_estimates Returns all Sales Estimates
getSalesEstimatesKey() GET /sales_estimates/{key} Returns a Sales Estimate
postSalesEstimates() POST /sales_estimates Creates a Sales Estimate
putSalesEstimatesKey() PUT /sales_estimates/{key} Updates a Sales Estimate

deleteSalesEstimatesKey()

deleteSalesEstimatesKey($key)

Deletes a Sales Estimate

Endpoint Availability * Accounting Plus: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Sales: Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\SalesEstimatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Sales Estimate Key.

try {
    $apiInstance->deleteSalesEstimatesKey($key);
} catch (Exception $e) {
    echo 'Exception when calling SalesEstimatesApi->deleteSalesEstimatesKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Sales Estimate Key.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getSalesEstimates()

getSalesEstimates($contactId, $search, $statusId, $fromDate, $toDate, $updatedOrCreatedSince, $hasAttachments, $itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\SalesEstimate[]

Returns all Sales Estimates

Endpoint Availability * Accounting Plus: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 * Accounting Standard: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 * Accounting Start: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Sales: Full Access, Read Only, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\SalesEstimatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$contactId = 'contactId_example'; // string | Use this to filter by contact id
$search = 'search_example'; // string | Use this to filter by the estimate reference or contact name.
$statusId = 'statusId_example'; // string | Use this to filter by status id
$fromDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Sales Estimates dates
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Sales Estimates dates
$updatedOrCreatedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Sales Estimates changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.
$hasAttachments = True; // bool | Use this to filter Sales Estimates by whether they have attachments or not
$itemsPerPage = 20; // int | Returns the given number of Sales Estimates per request.
$page = 1; // int | Go to specific page of Sales Estimates
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Sales Estimates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getSalesEstimates($contactId, $search, $statusId, $fromDate, $toDate, $updatedOrCreatedSince, $hasAttachments, $itemsPerPage, $page, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesEstimatesApi->getSalesEstimates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contactId string Use this to filter by contact id [optional]
search string Use this to filter by the estimate reference or contact name. [optional]
statusId string Use this to filter by status id [optional]
fromDate \DateTime Use this to filter by Sales Estimates dates [optional]
toDate \DateTime Use this to filter by Sales Estimates dates [optional]
updatedOrCreatedSince \DateTime Use this to limit the response to Sales Estimates changed since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
hasAttachments bool Use this to filter Sales Estimates by whether they have attachments or not [optional]
itemsPerPage int Returns the given number of Sales Estimates per request. [optional] [default to 20]
page int Go to specific page of Sales Estimates [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Sales Estimates (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\SalesEstimate[]

Authorization

No authorization required

HTTP request headers

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

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

getSalesEstimatesKey()

getSalesEstimatesKey($key, $nestedAttributes, $attributes): \SynergiTech\Sage\Model\SalesEstimate

Returns a Sales Estimate

Endpoint Availability * Accounting Plus: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 * Accounting Standard: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 * Accounting Start: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Sales: Full Access, Read Only, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\SalesEstimatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Sales Estimate Key.
$nestedAttributes = 'nestedAttributes_example'; // string | Specify the attributes that you want to expose for nested entities of the Sales Estimate (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Sales Estimate (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getSalesEstimatesKey($key, $nestedAttributes, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesEstimatesApi->getSalesEstimatesKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Sales Estimate Key.
nestedAttributes string Specify the attributes that you want to expose for nested entities of the Sales Estimate (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
attributes string Specify the attributes that you want to expose for the Sales Estimate (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\SalesEstimate

Authorization

No authorization required

HTTP request headers

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

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

postSalesEstimates()

postSalesEstimates($salesEstimates): \SynergiTech\Sage\Model\SalesEstimate

Creates a Sales Estimate

Endpoint Availability * Accounting Plus: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Sales: Full Access, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\SalesEstimatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$salesEstimates = new \SynergiTech\Sage\Model\PostSalesEstimates(); // \SynergiTech\Sage\Model\PostSalesEstimates

try {
    $result = $apiInstance->postSalesEstimates($salesEstimates);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesEstimatesApi->postSalesEstimates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
salesEstimates \SynergiTech\Sage\Model\PostSalesEstimates

Return type

\SynergiTech\Sage\Model\SalesEstimate

Authorization

No authorization required

HTTP request headers

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

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

putSalesEstimatesKey()

putSalesEstimatesKey($key, $salesEstimates): \SynergiTech\Sage\Model\SalesEstimate

Updates a Sales Estimate

Endpoint Availability * Accounting Plus: 🇨🇦, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area Sales: Full Access, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\SalesEstimatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$key = 'key_example'; // string | The Sales Estimate Key.
$salesEstimates = new \SynergiTech\Sage\Model\PutSalesEstimates(); // \SynergiTech\Sage\Model\PutSalesEstimates

try {
    $result = $apiInstance->putSalesEstimatesKey($key, $salesEstimates);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesEstimatesApi->putSalesEstimatesKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
key string The Sales Estimate Key.
salesEstimates \SynergiTech\Sage\Model\PutSalesEstimates

Return type

\SynergiTech\Sage\Model\SalesEstimate

Authorization

No authorization required

HTTP request headers

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

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