Skip to content

Latest commit

 

History

History
199 lines (134 loc) · 6.6 KB

ObjectEzmaxinvoicingApi.md

File metadata and controls

199 lines (134 loc) · 6.6 KB
Raw

eZmaxAPI\ObjectEzmaxinvoicingApi

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
ezmaxinvoicingGetAutocompleteV2() GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector} Retrieve Ezmaxinvoicings and IDs
ezmaxinvoicingGetObjectV2() GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} Retrieve an existing Ezmaxinvoicing
ezmaxinvoicingGetProvisionalV1() GET /1/object/ezmaxinvoicing/getProvisional Retrieve provisional Ezmaxinvoicing

ezmaxinvoicingGetAutocompleteV2()

ezmaxinvoicingGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\EzmaxinvoicingGetAutocompleteV2Response

Retrieve Ezmaxinvoicings and IDs

Get the list of Ezmaxinvoicing 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\ObjectEzmaxinvoicingApi(
    // 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 Ezmaxinvoicings 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\HeaderAcceptLanguage(); // HeaderAcceptLanguage

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

Parameters

Name Type Description Notes
sSelector string The type of Ezmaxinvoicings 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 HeaderAcceptLanguage [optional]

Return type

\eZmaxAPI\Model\EzmaxinvoicingGetAutocompleteV2Response

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]

ezmaxinvoicingGetObjectV2()

ezmaxinvoicingGetObjectV2($pkiEzmaxinvoicingID): \eZmaxAPI\Model\EzmaxinvoicingGetObjectV2Response

Retrieve an existing Ezmaxinvoicing

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

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

Parameters

Name Type Description Notes
pkiEzmaxinvoicingID int

Return type

\eZmaxAPI\Model\EzmaxinvoicingGetObjectV2Response

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]

ezmaxinvoicingGetProvisionalV1()

ezmaxinvoicingGetProvisionalV1(): \eZmaxAPI\Model\EzmaxinvoicingGetProvisionalV1Response

Retrieve provisional Ezmaxinvoicing

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\ObjectEzmaxinvoicingApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\eZmaxAPI\Model\EzmaxinvoicingGetProvisionalV1Response

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]