Skip to content

Files

Latest commit

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

History

History
382 lines (265 loc) · 16.8 KB

PurchaseCreditNotesApi.md

File metadata and controls

382 lines (265 loc) · 16.8 KB

SynergiTech\Sage\PurchaseCreditNotesApi

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

Method HTTP request Description
deletePurchaseCreditNotesKey() DELETE /purchase_credit_notes/{key} Deletes a Purchase Credit Note
getPurchaseCreditNotes() GET /purchase_credit_notes Returns all Purchase Credit Notes
getPurchaseCreditNotesKey() GET /purchase_credit_notes/{key} Returns a Purchase Credit Note
postPurchaseCreditNotes() POST /purchase_credit_notes Creates a Purchase Credit Note
postPurchaseCreditNotesKeyRelease() POST /purchase_credit_notes/{key}/release Releases a Purchase Credit Note
putPurchaseCreditNotesKey() PUT /purchase_credit_notes/{key} Updates a Purchase Credit Note

deletePurchaseCreditNotesKey()

deletePurchaseCreditNotesKey($key)

Deletes a Purchase Credit Note

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

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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 Purchase Credit Note Key.

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

Parameters

Name Type Description Notes
key string The Purchase Credit Note 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]

getPurchaseCreditNotes()

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

Returns all Purchase Credit Notes

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 Purchases: Full Access, Read Only, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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()
);
$showPaymentsAllocations = True; // bool | Use this to show the artefact's payments and allocations
$search = 'search_example'; // string | Use this to filter by the credit note reference or contact name.
$contactId = 'contactId_example'; // string | Use this to filter by contact id
$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 Purchase Credit Notes dates
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Purchase Credit Notes dates
$updatedOrCreatedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Purchase Credit Notes 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 Purchase Credit Notes 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.
$hasAttachments = True; // bool | Use this to filter Purchase Credit Notes by whether they have attachments or not
$itemsPerPage = 20; // int | Returns the given number of Purchase Credit Notes per request.
$page = 1; // int | Go to specific page of Purchase Credit Notes
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Purchase Credit Notes (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->getPurchaseCreditNotes($showPaymentsAllocations, $search, $contactId, $statusId, $fromDate, $toDate, $updatedOrCreatedSince, $deletedSince, $hasAttachments, $itemsPerPage, $page, $attributes, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PurchaseCreditNotesApi->getPurchaseCreditNotes: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
showPaymentsAllocations bool Use this to show the artefact's payments and allocations [optional]
search string Use this to filter by the credit note reference or contact name. [optional]
contactId string Use this to filter by contact id [optional]
statusId string Use this to filter by status id [optional]
fromDate \DateTime Use this to filter by Purchase Credit Notes dates [optional]
toDate \DateTime Use this to filter by Purchase Credit Notes dates [optional]
updatedOrCreatedSince \DateTime Use this to limit the response to Purchase Credit Notes 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 Purchase Credit Notes deleted 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 Purchase Credit Notes by whether they have attachments or not [optional]
itemsPerPage int Returns the given number of Purchase Credit Notes per request. [optional] [default to 20]
page int Go to specific page of Purchase Credit Notes [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Purchase Credit Notes (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\PurchaseCreditNote[]

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]

getPurchaseCreditNotesKey()

getPurchaseCreditNotesKey($key, $showPaymentsAllocations, $nestedAttributes, $showAnalysisTypes, $attributes): \SynergiTech\Sage\Model\PurchaseCreditNote

Returns a Purchase Credit Note

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 Purchases: Full Access, Read Only, Restricted Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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 Purchase Credit Note 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 Purchase Credit Note (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 Purchase Credit Note (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

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

Parameters

Name Type Description Notes
key string The Purchase Credit Note 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 Purchase Credit Note (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 Purchase Credit Note (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\PurchaseCreditNote

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]

postPurchaseCreditNotes()

postPurchaseCreditNotes($purchaseCreditNotes): \SynergiTech\Sage\Model\PurchaseCreditNote

Creates a Purchase Credit Note

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

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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()
);
$purchaseCreditNotes = new \SynergiTech\Sage\Model\PostPurchaseCreditNotes(); // \SynergiTech\Sage\Model\PostPurchaseCreditNotes

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

Parameters

Name Type Description Notes
purchaseCreditNotes \SynergiTech\Sage\Model\PostPurchaseCreditNotes

Return type

\SynergiTech\Sage\Model\PurchaseCreditNote

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]

postPurchaseCreditNotesKeyRelease()

postPurchaseCreditNotesKeyRelease($key): \SynergiTech\Sage\Model\PurchaseCreditNote

Releases a Purchase Credit Note

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

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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 Purchase Credit Note Key.

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

Parameters

Name Type Description Notes
key string The Purchase Credit Note Key.

Return type

\SynergiTech\Sage\Model\PurchaseCreditNote

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]

putPurchaseCreditNotesKey()

putPurchaseCreditNotesKey($key, $purchaseCreditNotes): \SynergiTech\Sage\Model\PurchaseCreditNote

Updates a Purchase Credit Note

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

Example

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



$apiInstance = new SynergiTech\Sage\Api\PurchaseCreditNotesApi(
    // 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 Purchase Credit Note Key.
$purchaseCreditNotes = new \SynergiTech\Sage\Model\PutPurchaseCreditNotes(); // \SynergiTech\Sage\Model\PutPurchaseCreditNotes

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

Parameters

Name Type Description Notes
key string The Purchase Credit Note Key.
purchaseCreditNotes \SynergiTech\Sage\Model\PutPurchaseCreditNotes

Return type

\SynergiTech\Sage\Model\PurchaseCreditNote

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]