Skip to content

ObjectOtherincomeApi.md

Latest commit

 

History

History
397 lines (267 loc) · 13.1 KB

ObjectOtherincomeApi.md

File metadata and controls

397 lines (267 loc) · 13.1 KB

eZmaxAPI\ObjectOtherincomeApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
otherincomeGetCommunicationCountV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount Retrieve Communication count
otherincomeGetCommunicationListV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
otherincomeGetCommunicationrecipientsV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients Retrieve Otherincome's Communicationrecipient
otherincomeGetCommunicationsendersV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders Retrieve Otherincome's Communicationsender
otherincomeGetListV1() GET /1/object/otherincome/getList Retrieve Otherincome list
otherincomeImportIntoEDMV1() POST /1/object/otherincome/{pkiOtherincomeID}/importIntoEDM Import attachments into the Otherincome

otherincomeGetCommunicationCountV1()

otherincomeGetCommunicationCountV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationCountV1Response

Retrieve Communication count

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

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

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

otherincomeGetCommunicationListV1()

otherincomeGetCommunicationListV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationListV1Response

Retrieve Communication list

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

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

otherincomeGetCommunicationrecipientsV1()

otherincomeGetCommunicationrecipientsV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationrecipientsV1Response

Retrieve Otherincome's Communicationrecipient

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

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

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

otherincomeGetCommunicationsendersV1()

otherincomeGetCommunicationsendersV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationsendersV1Response

Retrieve Otherincome's Communicationsender

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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

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

otherincomeGetListV1()

otherincomeGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\OtherincomeGetListV1Response

Retrieve Otherincome list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eOtherincomeRemunerationtype | Dollars
DollarsTaxesIncluded |

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->otherincomeGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectOtherincomeApi->otherincomeGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\OtherincomeGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

otherincomeImportIntoEDMV1()

otherincomeImportIntoEDMV1($pkiOtherincomeID, $otherincomeImportIntoEDMV1Request): \eZmaxAPI\Model\OtherincomeImportIntoEDMV1Response

Import attachments into the Otherincome

Example

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


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int
$otherincomeImportIntoEDMV1Request = new \eZmaxAPI\Model\OtherincomeImportIntoEDMV1Request(); // \eZmaxAPI\Model\OtherincomeImportIntoEDMV1Request

try {
    $result = $apiInstance->otherincomeImportIntoEDMV1($pkiOtherincomeID, $otherincomeImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectOtherincomeApi->otherincomeImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiOtherincomeID int
otherincomeImportIntoEDMV1Request \eZmaxAPI\Model\OtherincomeImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\OtherincomeImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

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

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