DocumentExportApi.md

Swagger\Client\DocumentExportApi

All URIs are relative to https://api.billingo.hu/v3

Method	HTTP request	Description
create	POST /document-export	Create document export.
download	GET /document-export/{id}/download	Return exported binary file.
poll	GET /document-export/{id}/poll	Retrieve export state.

create

\Swagger\Client\Model\DocumentExportId create($body)

Create document export.

Return with the id of the export.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\DocumentExportApi(
    // 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
);
$body = new \Swagger\Client\Model\CreateDocumentExport(); // \Swagger\Client\Model\CreateDocumentExport | Create document export body.

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\CreateDocumentExport	Create document export body.

Return type

\Swagger\Client\Model\DocumentExportId

Authorization

api_key

HTTP request headers

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

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

download

string download($id)

Return exported binary file.

Return the exported file.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\DocumentExportApi(
    // 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
);
$id = "id_example"; // string | The ID from create document export endpoint.

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

Parameters

Name	Type	Description	Notes
id	string	The ID from create document export endpoint.

Return type

string

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/_*, application/json

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

poll

\Swagger\Client\Model\DocumentExportStatus poll($id)

Retrieve export state.

Return state of the given export.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\DocumentExportApi(
    // 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
);
$id = "id_example"; // string | The ID from create document export endpoint.

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

Parameters

Name	Type	Description	Notes
id	string	The ID from create document export endpoint.

Return type

\Swagger\Client\Model\DocumentExportStatus

Authorization

api_key

HTTP request headers

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

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