Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 5.34 KB

LedgerAccountClassificationsApi.md

File metadata and controls

129 lines (88 loc) · 5.34 KB

SynergiTech\Sage\LedgerAccountClassificationsApi

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

Method HTTP request Description
getLedgerAccountClassifications() GET /ledger_account_classifications Returns all Ledger Account Classifications
getLedgerAccountClassificationsKey() GET /ledger_account_classifications/{key} Returns a Ledger Account Classification

getLedgerAccountClassifications()

getLedgerAccountClassifications($ledgerAccountTypeId, $itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\Base[]

Returns all Ledger Account Classifications

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Example

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



$apiInstance = new SynergiTech\Sage\Api\LedgerAccountClassificationsApi(
    // 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()
);
$ledgerAccountTypeId = 'ledgerAccountTypeId_example'; // string | Use this to filter by ledger account type id
$itemsPerPage = 20; // int | Returns the given number of Ledger Account Classifications per request.
$page = 1; // int | Go to specific page of Ledger Account Classifications
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Ledger Account Classifications (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

try {
    $result = $apiInstance->getLedgerAccountClassifications($ledgerAccountTypeId, $itemsPerPage, $page, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LedgerAccountClassificationsApi->getLedgerAccountClassifications: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
ledgerAccountTypeId string Use this to filter by ledger account type id [optional]
itemsPerPage int Returns the given number of Ledger Account Classifications per request. [optional] [default to 20]
page int Go to specific page of Ledger Account Classifications [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Ledger Account Classifications (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\Base[]

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]

getLedgerAccountClassificationsKey()

getLedgerAccountClassificationsKey($key, $attributes): \SynergiTech\Sage\Model\Base

Returns a Ledger Account Classification

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Example

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



$apiInstance = new SynergiTech\Sage\Api\LedgerAccountClassificationsApi(
    // 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 Ledger Account Classification Key.
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Ledger Account Classification (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

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

Parameters

Name Type Description Notes
key string The Ledger Account Classification Key.
attributes string Specify the attributes that you want to expose for the Ledger Account Classification (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\Base

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]