Skip to content

ObjectElectronicfundstransferApi.md

Latest commit

 

History

History
326 lines (216 loc) · 11.7 KB

ObjectElectronicfundstransferApi.md

File metadata and controls

326 lines (216 loc) · 11.7 KB

eZmaxAPI\ObjectElectronicfundstransferApi

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
electronicfundstransferGetCommunicationCountV1() GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationCount Retrieve Communication count
electronicfundstransferGetCommunicationListV1() GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList Retrieve Communication list
electronicfundstransferGetCommunicationrecipientsV1() GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationrecipients Retrieve Electronicfundstransfer's Communicationrecipient
electronicfundstransferGetCommunicationsendersV1() GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationsenders Retrieve Electronicfundstransfer's Communicationsender
electronicfundstransferImportIntoEDMV1() POST /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/importIntoEDM Import attachments into the Electronicfundstransfer

electronicfundstransferGetCommunicationCountV1()

electronicfundstransferGetCommunicationCountV1($pkiElectronicfundstransferID): \eZmaxAPI\Model\ElectronicfundstransferGetCommunicationCountV1Response

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\ObjectElectronicfundstransferApi(
    // 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
);
$pkiElectronicfundstransferID = 56; // int

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

Parameters

Name Type Description Notes
pkiElectronicfundstransferID int

Return type

\eZmaxAPI\Model\ElectronicfundstransferGetCommunicationCountV1Response

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]

electronicfundstransferGetCommunicationListV1()

electronicfundstransferGetCommunicationListV1($pkiElectronicfundstransferID): \eZmaxAPI\Model\ElectronicfundstransferGetCommunicationListV1Response

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\ObjectElectronicfundstransferApi(
    // 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
);
$pkiElectronicfundstransferID = 56; // int

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

Parameters

Name Type Description Notes
pkiElectronicfundstransferID int

Return type

\eZmaxAPI\Model\ElectronicfundstransferGetCommunicationListV1Response

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]

electronicfundstransferGetCommunicationrecipientsV1()

electronicfundstransferGetCommunicationrecipientsV1($pkiElectronicfundstransferID): \eZmaxAPI\Model\ElectronicfundstransferGetCommunicationrecipientsV1Response

Retrieve Electronicfundstransfer'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\ObjectElectronicfundstransferApi(
    // 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
);
$pkiElectronicfundstransferID = 56; // int

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

Parameters

Name Type Description Notes
pkiElectronicfundstransferID int

Return type

\eZmaxAPI\Model\ElectronicfundstransferGetCommunicationrecipientsV1Response

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]

electronicfundstransferGetCommunicationsendersV1()

electronicfundstransferGetCommunicationsendersV1($pkiElectronicfundstransferID): \eZmaxAPI\Model\ElectronicfundstransferGetCommunicationsendersV1Response

Retrieve Electronicfundstransfer'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\ObjectElectronicfundstransferApi(
    // 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
);
$pkiElectronicfundstransferID = 56; // int

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

Parameters

Name Type Description Notes
pkiElectronicfundstransferID int

Return type

\eZmaxAPI\Model\ElectronicfundstransferGetCommunicationsendersV1Response

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]

electronicfundstransferImportIntoEDMV1()

electronicfundstransferImportIntoEDMV1($pkiElectronicfundstransferID, $electronicfundstransferImportIntoEDMV1Request): \eZmaxAPI\Model\ElectronicfundstransferImportIntoEDMV1Response

Import attachments into the Electronicfundstransfer

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\ObjectElectronicfundstransferApi(
    // 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
);
$pkiElectronicfundstransferID = 56; // int
$electronicfundstransferImportIntoEDMV1Request = new \eZmaxAPI\Model\ElectronicfundstransferImportIntoEDMV1Request(); // \eZmaxAPI\Model\ElectronicfundstransferImportIntoEDMV1Request

try {
    $result = $apiInstance->electronicfundstransferImportIntoEDMV1($pkiElectronicfundstransferID, $electronicfundstransferImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectElectronicfundstransferApi->electronicfundstransferImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiElectronicfundstransferID int
electronicfundstransferImportIntoEDMV1Request \eZmaxAPI\Model\ElectronicfundstransferImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\ElectronicfundstransferImportIntoEDMV1Response

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]