Skip to content

Files

Latest commit

MattHadfield113MattHadfield113
Updated Swagger.
Feb 18, 2025
d81bb92 · Feb 18, 2025

History

History
325 lines (227 loc) · 14.8 KB

SalesQuickEntriesApi.md

File metadata and controls

325 lines (227 loc) · 14.8 KB

SynergiTech\Sage\SalesQuickEntriesApi

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

Method HTTP request Description
deleteSalesQuickEntriesKey() DELETE /sales_quick_entries/{key} Deletes a Sales Quick Entry
getSalesQuickEntries() GET /sales_quick_entries Returns all Sales Quick Entries
getSalesQuickEntriesKey() GET /sales_quick_entries/{key} Returns a Sales Quick Entry
postSalesQuickEntries() POST /sales_quick_entries Creates a Sales Quick Entry
putSalesQuickEntriesKey() PUT /sales_quick_entries/{key} Updates a Sales Quick Entry

deleteSalesQuickEntriesKey()

deleteSalesQuickEntriesKey($key)

Deletes a Sales Quick Entry

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 ### 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\SalesQuickEntriesApi(
    // 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 Quick Entry Key.

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

Parameters

Name Type Description Notes
key string The Sales Quick Entry 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]

getSalesQuickEntries()

getSalesQuickEntries($contactId, $search, $statusId, $fromDate, $toDate, $updatedOrCreatedSince, $deletedSince, $showPaymentsAllocations, $hasAttachments, $itemsPerPage, $page, $attributes, $sort): \SynergiTech\Sage\Model\QuickEntry[]

Returns all Sales Quick Entries

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\SalesQuickEntriesApi(
    // 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 quick entry 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 Batch Entries dates
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Sales Batch Entries dates
$updatedOrCreatedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Sales Batch Entries 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.
$deletedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Sales Batch Entries deleted since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Not inclusive of the passed timestamp.
$showPaymentsAllocations = True; // bool | Use this to show the artefact's payments and allocations
$hasAttachments = True; // bool | Use this to filter Sales Batch Entries by whether they have attachments or not
$itemsPerPage = 20; // int | Returns the given number of Sales Batch Entries per request.
$page = 1; // int | Go to specific page of Sales Batch Entries
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Sales Batch Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
$sort = 'sort_example'; // string | Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`). Available attributes are: created_at, updated_at, date  Example: `sort=created_at` or `sort=created_at:desc`

try {
    $result = $apiInstance->getSalesQuickEntries($contactId, $search, $statusId, $fromDate, $toDate, $updatedOrCreatedSince, $deletedSince, $showPaymentsAllocations, $hasAttachments, $itemsPerPage, $page, $attributes, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesQuickEntriesApi->getSalesQuickEntries: ', $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 quick entry reference or contact name. [optional]
statusId string Use this to filter by status id [optional]
fromDate \DateTime Use this to filter by Sales Batch Entries dates [optional]
toDate \DateTime Use this to filter by Sales Batch Entries dates [optional]
updatedOrCreatedSince \DateTime Use this to limit the response to Sales Batch Entries changed since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
deletedSince \DateTime Use this to limit the response to Sales Batch Entries deleted since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
showPaymentsAllocations bool Use this to show the artefact's payments and allocations [optional]
hasAttachments bool Use this to filter Sales Batch Entries by whether they have attachments or not [optional]
itemsPerPage int Returns the given number of Sales Batch Entries per request. [optional] [default to 20]
page int Go to specific page of Sales Batch Entries [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Sales Batch Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
sort string Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`). Available attributes are: created_at, updated_at, date Example: `sort=created_at` or `sort=created_at:desc` [optional]

Return type

\SynergiTech\Sage\Model\QuickEntry[]

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]

getSalesQuickEntriesKey()

getSalesQuickEntriesKey($key, $showPaymentsAllocations, $nestedAttributes, $showAnalysisTypes, $attributes): \SynergiTech\Sage\Model\QuickEntry

Returns a Sales Quick Entry

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\SalesQuickEntriesApi(
    // 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 Quick Entry Key.
$showPaymentsAllocations = True; // bool | Use this to show the artefact's payments and allocations
$nestedAttributes = 'nestedAttributes_example'; // string | Specify the attributes that you want to expose for nested entities of the Sales Batch Entry (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
$showAnalysisTypes = True; // bool | Use this to show the line item analysis types
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Sales Batch Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

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

Parameters

Name Type Description Notes
key string The Sales Quick Entry Key.
showPaymentsAllocations bool Use this to show the artefact's payments and allocations [optional]
nestedAttributes string Specify the attributes that you want to expose for nested entities of the Sales Batch Entry (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
showAnalysisTypes bool Use this to show the line item analysis types [optional]
attributes string Specify the attributes that you want to expose for the Sales Batch Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\QuickEntry

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]

postSalesQuickEntries()

postSalesQuickEntries($salesQuickEntries): \SynergiTech\Sage\Model\QuickEntry

Creates a Sales Quick Entry

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 ### 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\SalesQuickEntriesApi(
    // 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()
);
$salesQuickEntries = new \SynergiTech\Sage\Model\PostSalesQuickEntries(); // \SynergiTech\Sage\Model\PostSalesQuickEntries

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

Parameters

Name Type Description Notes
salesQuickEntries \SynergiTech\Sage\Model\PostSalesQuickEntries

Return type

\SynergiTech\Sage\Model\QuickEntry

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]

putSalesQuickEntriesKey()

putSalesQuickEntriesKey($key, $salesQuickEntries): \SynergiTech\Sage\Model\QuickEntry

Updates a Sales Quick Entry

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 ### 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\SalesQuickEntriesApi(
    // 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 Quick Entry Key.
$salesQuickEntries = new \SynergiTech\Sage\Model\PutSalesQuickEntries(); // \SynergiTech\Sage\Model\PutSalesQuickEntries

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

Parameters

Name Type Description Notes
key string The Sales Quick Entry Key.
salesQuickEntries \SynergiTech\Sage\Model\PutSalesQuickEntries

Return type

\SynergiTech\Sage\Model\QuickEntry

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]