Skip to content

Latest commit

 

History

History
329 lines (226 loc) · 11.3 KB

SpyJournalPageApi.md

File metadata and controls

329 lines (226 loc) · 11.3 KB

Spy\MsbcRestClient\SpyJournalPageApi

All URIs are relative to https://api.businesscentral.dynamics.com/v2.0/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/Production/ODataV4/Company('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'), except if the operation defines another base path.

Method HTTP request Description
createJournalEntry() POST /SpyJournalPage
deleteJournalEntry() DELETE /SpyJournalPage('{JournalTemplateName}','{JournalBatchName}',{LineNo})
editJournalEntry() PATCH /SpyJournalPage('{JournalTemplateName}','{JournalBatchName}',{LineNo})
getJournalEntries() GET /SpyJournalPage
getJournalEntry() GET /SpyJournalPage('{JournalTemplateName}','{JournalBatchName}',{LineNo})

createJournalEntry()

createJournalEntry($spy_journal_entry, $select): \Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Example

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


// Configure Bearer authorization: bearerAuth
$config = Spy\MsbcRestClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Spy\MsbcRestClient\Api\SpyJournalPageApi(
    // 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(),
    $config
);
$spy_journal_entry = new \Spy\MsbcRestClient\Model\SpyJournalEntry(); // \Spy\MsbcRestClient\Model\SpyJournalEntry
$select = 'select_example'; // string

try {
    $result = $apiInstance->createJournalEntry($spy_journal_entry, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpyJournalPageApi->createJournalEntry: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
spy_journal_entry \Spy\MsbcRestClient\Model\SpyJournalEntry
select string [optional]

Return type

\Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteJournalEntry()

deleteJournalEntry($journal_template_name, $journal_batch_name, $line_no)

Example

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


// Configure Bearer authorization: bearerAuth
$config = Spy\MsbcRestClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Spy\MsbcRestClient\Api\SpyJournalPageApi(
    // 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(),
    $config
);
$journal_template_name = 'journal_template_name_example'; // string | The Journal Template Name of the JournalEntry to retrieve
$journal_batch_name = 'journal_batch_name_example'; // string | The Journal Batch Name of the JournalEntry to retrieve
$line_no = 56; // int | The Line No of the JournalEntry to retrieve

try {
    $apiInstance->deleteJournalEntry($journal_template_name, $journal_batch_name, $line_no);
} catch (Exception $e) {
    echo 'Exception when calling SpyJournalPageApi->deleteJournalEntry: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
journal_template_name string The Journal Template Name of the JournalEntry to retrieve
journal_batch_name string The Journal Batch Name of the JournalEntry to retrieve
line_no int The Line No of the JournalEntry to retrieve

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editJournalEntry()

editJournalEntry($journal_template_name, $journal_batch_name, $line_no, $if_match, $spy_journal_entry, $select): \Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Example

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


// Configure Bearer authorization: bearerAuth
$config = Spy\MsbcRestClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Spy\MsbcRestClient\Api\SpyJournalPageApi(
    // 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(),
    $config
);
$journal_template_name = 'journal_template_name_example'; // string | The Journal Template Name of the JournalEntry to retrieve
$journal_batch_name = 'journal_batch_name_example'; // string | The Journal Batch Name of the JournalEntry to retrieve
$line_no = 56; // int | The Line No of the JournalEntry to retrieve
$if_match = 'if_match_example'; // string | The ETag of the Entity to update
$spy_journal_entry = new \Spy\MsbcRestClient\Model\SpyJournalEntry(); // \Spy\MsbcRestClient\Model\SpyJournalEntry
$select = 'select_example'; // string

try {
    $result = $apiInstance->editJournalEntry($journal_template_name, $journal_batch_name, $line_no, $if_match, $spy_journal_entry, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpyJournalPageApi->editJournalEntry: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
journal_template_name string The Journal Template Name of the JournalEntry to retrieve
journal_batch_name string The Journal Batch Name of the JournalEntry to retrieve
line_no int The Line No of the JournalEntry to retrieve
if_match string The ETag of the Entity to update
spy_journal_entry \Spy\MsbcRestClient\Model\SpyJournalEntry
select string [optional]

Return type

\Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJournalEntries()

getJournalEntries($filter, $select, $data_access_intent): \Spy\MsbcRestClient\Model\SpyJournalEntriesListResponse

Example

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


// Configure Bearer authorization: bearerAuth
$config = Spy\MsbcRestClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Spy\MsbcRestClient\Api\SpyJournalPageApi(
    // 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(),
    $config
);
$filter = 'filter_example'; // string
$select = 'select_example'; // string
$data_access_intent = 'ReadOnly'; // string | Data Access Intent

try {
    $result = $apiInstance->getJournalEntries($filter, $select, $data_access_intent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpyJournalPageApi->getJournalEntries: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
filter string [optional]
select string [optional]
data_access_intent string Data Access Intent [optional] [default to 'ReadOnly']

Return type

\Spy\MsbcRestClient\Model\SpyJournalEntriesListResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJournalEntry()

getJournalEntry($journal_template_name, $journal_batch_name, $line_no, $data_access_intent, $select): \Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Example

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


// Configure Bearer authorization: bearerAuth
$config = Spy\MsbcRestClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Spy\MsbcRestClient\Api\SpyJournalPageApi(
    // 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(),
    $config
);
$journal_template_name = 'journal_template_name_example'; // string | The Journal Template Name of the JournalEntry to retrieve
$journal_batch_name = 'journal_batch_name_example'; // string | The Journal Batch Name of the JournalEntry to retrieve
$line_no = 56; // int | The Line No of the JournalEntry to retrieve
$data_access_intent = 'ReadOnly'; // string | Data Access Intent
$select = 'select_example'; // string

try {
    $result = $apiInstance->getJournalEntry($journal_template_name, $journal_batch_name, $line_no, $data_access_intent, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpyJournalPageApi->getJournalEntry: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
journal_template_name string The Journal Template Name of the JournalEntry to retrieve
journal_batch_name string The Journal Batch Name of the JournalEntry to retrieve
line_no int The Line No of the JournalEntry to retrieve
data_access_intent string Data Access Intent [optional] [default to 'ReadOnly']
select string [optional]

Return type

\Spy\MsbcRestClient\Model\SpyJournalEntryResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]