Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 3.15 KB

DocumentApi.md

File metadata and controls

77 lines (54 loc) · 3.15 KB

Teambank\EasyCreditApiV3\DocumentApi

All URIs are relative to https://partner.easycredit-ratenkauf.de, except if the operation defines another base path.

Method HTTP request Description
apiMerchantV3DocumentsGet() GET /api/merchant/v3/documents Download billing documents of a merchant.

apiMerchantV3DocumentsGet()

apiMerchantV3DocumentsGet($billingDateFrom, $billingDateTo, $documentType, $fileType): \SplFileObject

Download billing documents of a merchant.

' Download billing documents of a merchant. Following parameters can be given to restrict: billing date from/to, document type, webshop id and file type If no date range is given, all billing documents of the last month will be returned. '

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Teambank\EasyCreditApiV3\Configuration::getDefaultConfiguration()
              ->setHost('https://ratenkauf.easycredit.de')
              ->setUsername('1.de.1234.1') // use your "Webshop-ID"
              ->setPassword('YOUR_API_KEY'); // use your "API-Kennwort"


$apiInstance = new Teambank\EasyCreditApiV3\Api\DocumentApi(
    // 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
);
$billingDateFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | set by default to the last month if not specified
$billingDateTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | set by default to billingDateFrom + one month if not specified
$documentType = array('documentType_example'); // string[] | set by default to all options if not specified
$fileType = array('fileType_example'); // string[] | set by default to all options if not specified

try {
    $result = $apiInstance->apiMerchantV3DocumentsGet($billingDateFrom, $billingDateTo, $documentType, $fileType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->apiMerchantV3DocumentsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
billingDateFrom \DateTime set by default to the last month if not specified [optional]
billingDateTo \DateTime set by default to billingDateFrom + one month if not specified [optional]
documentType string[] set by default to all options if not specified [optional]
fileType string[] set by default to all options if not specified [optional]

Return type

\SplFileObject

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/zip, application/problem+json

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