Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 5.07 KB

LedgerAccountTypesApi.md

File metadata and controls

129 lines (88 loc) · 5.07 KB

SynergiTech\Sage\LedgerAccountTypesApi

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

Method HTTP request Description
getLedgerAccountTypes() GET /ledger_account_types Returns all Ledger Account Types
getLedgerAccountTypesKey() GET /ledger_account_types/{key} Returns a Ledger Account Type

getLedgerAccountTypes()

getLedgerAccountTypes($ledgerAccountClassificationId, $itemsPerPage, $page, $attributes): \SynergiTech\Sage\Model\Base[]

Returns all Ledger Account Types

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

Example

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



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

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

Parameters

Name Type Description Notes
ledgerAccountClassificationId string Use this to filter by ledger account classification id [optional]
itemsPerPage int Returns the given number of Ledger Account Types per request. [optional] [default to 20]
page int Go to specific page of Ledger Account Types [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Ledger Account Types (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]

getLedgerAccountTypesKey()

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

Returns a Ledger Account Type

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

Example

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



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

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

Parameters

Name Type Description Notes
key string The Ledger Account Type Key.
attributes string Specify the attributes that you want to expose for the Ledger Account Type (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]