Skip to content

Latest commit

 

History

History
143 lines (102 loc) · 7.28 KB

LedgerEntriesApi.md

File metadata and controls

143 lines (102 loc) · 7.28 KB

SynergiTech\Sage\LedgerEntriesApi

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

Method HTTP request Description
getLedgerEntries() GET /ledger_entries Returns all Ledger Entries
getLedgerEntriesKey() GET /ledger_entries/{key} Returns a Ledger Entry

getLedgerEntries()

getLedgerEntries($fromDate, $toDate, $transactionId, $transactionTypeId, $journalCodeId, $updatedOrCreatedSince, $itemsPerPage, $page, $attributes, $ledgerAccountId): \SynergiTech\Sage\Model\LedgerEntry[]

Returns all Ledger 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 Journals: Read Only, Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\LedgerEntriesApi(
    // 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()
);
$fromDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Ledger Entries dates
$toDate = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to filter by Ledger Entries dates
$transactionId = 'transactionId_example'; // string | Use this to filter by transaction id
$transactionTypeId = 'transactionTypeId_example'; // string | Use this to filter by transaction type id
$journalCodeId = 'journalCodeId_example'; // string | Use this to filter by journal code id
$updatedOrCreatedSince = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | Use this to limit the response to Ledger 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.
$itemsPerPage = 20; // int | Returns the given number of Ledger Entries per request.
$page = 1; // int | Go to specific page of Ledger Entries
$attributes = 'attributes_example'; // string | Specify the attributes that you want to expose for the Ledger Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
$ledgerAccountId = 'ledgerAccountId_example'; // string | Use this to filter by ledger account id

try {
    $result = $apiInstance->getLedgerEntries($fromDate, $toDate, $transactionId, $transactionTypeId, $journalCodeId, $updatedOrCreatedSince, $itemsPerPage, $page, $attributes, $ledgerAccountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LedgerEntriesApi->getLedgerEntries: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
fromDate \DateTime Use this to filter by Ledger Entries dates [optional]
toDate \DateTime Use this to filter by Ledger Entries dates [optional]
transactionId string Use this to filter by transaction id [optional]
transactionTypeId string Use this to filter by transaction type id [optional]
journalCodeId string Use this to filter by journal code id [optional]
updatedOrCreatedSince \DateTime Use this to limit the response to Ledger Entries changed since a given date (format: YYYY-MM-DDT(+ -)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+
itemsPerPage int Returns the given number of Ledger Entries per request. [optional] [default to 20]
page int Go to specific page of Ledger Entries [optional] [default to 1]
attributes string Specify the attributes that you want to expose for the Ledger Entries (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]
ledgerAccountId string Use this to filter by ledger account id [optional]

Return type

\SynergiTech\Sage\Model\LedgerEntry[]

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]

getLedgerEntriesKey()

getLedgerEntriesKey($key, $nestedAttributes, $attributes): \SynergiTech\Sage\Model\LedgerEntry

Returns a Ledger 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 Journals: Read Only, Full Access

Example

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



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

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

Parameters

Name Type Description Notes
key string The Ledger Entry Key.
nestedAttributes string Specify the attributes that you want to expose for nested entities of the Ledger Entry (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 Ledger Entry (expose all attributes with 'all'). These are in addition to the base attributes (name, path) [optional]

Return type

\SynergiTech\Sage\Model\LedgerEntry

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]