Skip to content

Latest commit

 

History

History
338 lines (233 loc) · 12.2 KB

ObjectVariableexpenseApi.md

File metadata and controls

338 lines (233 loc) · 12.2 KB

eZmaxAPI\ObjectVariableexpenseApi

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
variableexpenseCreateObjectV1() POST /1/object/variableexpense Create a new Variableexpense
variableexpenseEditObjectV1() PUT /1/object/variableexpense/{pkiVariableexpenseID} Edit an existing Variableexpense
variableexpenseGetAutocompleteV2() GET /2/object/variableexpense/getAutocomplete/{sSelector} Retrieve Variableexpenses and IDs
variableexpenseGetListV1() GET /1/object/variableexpense/getList Retrieve Variableexpense list
variableexpenseGetObjectV2() GET /2/object/variableexpense/{pkiVariableexpenseID} Retrieve an existing Variableexpense

variableexpenseCreateObjectV1()

variableexpenseCreateObjectV1($variableexpenseCreateObjectV1Request): \eZmaxAPI\Model\VariableexpenseCreateObjectV1Response

Create a new Variableexpense

The endpoint allows to create one or many elements at once.

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\ObjectVariableexpenseApi(
    // 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
);
$variableexpenseCreateObjectV1Request = new \eZmaxAPI\Model\VariableexpenseCreateObjectV1Request(); // \eZmaxAPI\Model\VariableexpenseCreateObjectV1Request

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

Parameters

Name Type Description Notes
variableexpenseCreateObjectV1Request \eZmaxAPI\Model\VariableexpenseCreateObjectV1Request

Return type

\eZmaxAPI\Model\VariableexpenseCreateObjectV1Response

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]

variableexpenseEditObjectV1()

variableexpenseEditObjectV1($pkiVariableexpenseID, $variableexpenseEditObjectV1Request): \eZmaxAPI\Model\VariableexpenseEditObjectV1Response

Edit an existing Variableexpense

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\ObjectVariableexpenseApi(
    // 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
);
$pkiVariableexpenseID = 56; // int
$variableexpenseEditObjectV1Request = new \eZmaxAPI\Model\VariableexpenseEditObjectV1Request(); // \eZmaxAPI\Model\VariableexpenseEditObjectV1Request

try {
    $result = $apiInstance->variableexpenseEditObjectV1($pkiVariableexpenseID, $variableexpenseEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectVariableexpenseApi->variableexpenseEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiVariableexpenseID int
variableexpenseEditObjectV1Request \eZmaxAPI\Model\VariableexpenseEditObjectV1Request

Return type

\eZmaxAPI\Model\VariableexpenseEditObjectV1Response

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]

variableexpenseGetAutocompleteV2()

variableexpenseGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\VariableexpenseGetAutocompleteV2Response

Retrieve Variableexpenses and IDs

Get the list of Variableexpense to be used in a dropdown or autocomplete control.

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\ObjectVariableexpenseApi(
    // 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
);
$sSelector = 'sSelector_example'; // string | The type of Variableexpenses to return
$eFilterActive = 'Active'; // string | Specify which results we want to display.
$sQuery = 'sQuery_example'; // string | Allow to filter the returned results
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage

try {
    $result = $apiInstance->variableexpenseGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectVariableexpenseApi->variableexpenseGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sSelector string The type of Variableexpenses to return
eFilterActive string Specify which results we want to display. [optional] [default to 'Active']
sQuery string Allow to filter the returned results [optional]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]

Return type

\eZmaxAPI\Model\VariableexpenseGetAutocompleteV2Response

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]

variableexpenseGetListV1()

variableexpenseGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\VariableexpenseGetListV1Response

Retrieve Variableexpense list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included |

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\ObjectVariableexpenseApi(
    // 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->variableexpenseGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectVariableexpenseApi->variableexpenseGetListV1: ', $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\VariableexpenseGetListV1Response

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]

variableexpenseGetObjectV2()

variableexpenseGetObjectV2($pkiVariableexpenseID): \eZmaxAPI\Model\VariableexpenseGetObjectV2Response

Retrieve an existing Variableexpense

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

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

Parameters

Name Type Description Notes
pkiVariableexpenseID int

Return type

\eZmaxAPI\Model\VariableexpenseGetObjectV2Response

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]