Skip to content

Latest commit

 

History

History
297 lines (219 loc) · 10.5 KB

SepaPaymentApi.md

File metadata and controls

297 lines (219 loc) · 10.5 KB
Raw

Swagger\Client\SepaPaymentApi

All URIs are relative to https://api.easybill.de/rest/v1

Method HTTP request Description
sepaPaymentsGet GET /sepa-payments Fetch SEPA payments list
sepaPaymentsIdDelete DELETE /sepa-payments/{id} Delete SEPA payment
sepaPaymentsIdGet GET /sepa-payments/{id} Fetch SEPA payment
sepaPaymentsIdPut PUT /sepa-payments/{id} Update SEPA payment
sepaPaymentsPost POST /sepa-payments Create SEPA payment

sepaPaymentsGet

\Swagger\Client\Model\SEPAPayments sepaPaymentsGet($limit, $page, $document_id)

Fetch SEPA payments list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\SepaPaymentApi(
    // 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
);
$limit = 56; // int | Limited the result. Default is 100. Maximum can be 1000.
$page = 56; // int | Set current Page. Default is 1.
$document_id = "document_id_example"; // string | Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id.

try {
    $result = $apiInstance->sepaPaymentsGet($limit, $page, $document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SepaPaymentApi->sepaPaymentsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
limit int Limited the result. Default is 100. Maximum can be 1000. [optional]
page int Set current Page. Default is 1. [optional]
document_id string Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id. [optional]

Return type

\Swagger\Client\Model\SEPAPayments

Authorization

Bearer, basicAuth

HTTP request headers

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

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

sepaPaymentsIdDelete

sepaPaymentsIdDelete($id)

Delete SEPA payment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\SepaPaymentApi(
    // 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 = 789; // int | ID of SPEA payment

try {
    $apiInstance->sepaPaymentsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling SepaPaymentApi->sepaPaymentsIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int ID of SPEA payment

Return type

void (empty response body)

Authorization

Bearer, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

sepaPaymentsIdGet

\Swagger\Client\Model\SEPAPayment sepaPaymentsIdGet($id)

Fetch SEPA payment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\SepaPaymentApi(
    // 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 = 789; // int | ID of SEPA payment

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

Parameters

Name Type Description Notes
id int ID of SEPA payment

Return type

\Swagger\Client\Model\SEPAPayment

Authorization

Bearer, basicAuth

HTTP request headers

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

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

sepaPaymentsIdPut

\Swagger\Client\Model\SEPAPayment sepaPaymentsIdPut($body, $id)

Update SEPA payment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\SepaPaymentApi(
    // 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\SEPAPayment(); // \Swagger\Client\Model\SEPAPayment | 
$id = 789; // int | ID of SEPA payment

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\SEPAPayment
id int ID of SEPA payment

Return type

\Swagger\Client\Model\SEPAPayment

Authorization

Bearer, basicAuth

HTTP request headers

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

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

sepaPaymentsPost

\Swagger\Client\Model\SEPAPayment sepaPaymentsPost($body)

Create SEPA payment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Bearer
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\SepaPaymentApi(
    // 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\SEPAPayment(); // \Swagger\Client\Model\SEPAPayment | 

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\SEPAPayment

Return type

\Swagger\Client\Model\SEPAPayment

Authorization

Bearer, basicAuth

HTTP request headers

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

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