All URIs are relative to https://api.mittwald.de/v1
Method | HTTP request | Description |
---|---|---|
getBenefitDetails | GET /customers/{customerNumber}/benefits/{benefit} | Details zu einer gebuchten Leistung |
getCurrentCustomer | GET /customer | Details zu dem aktuellem Kunden |
getCustomer | GET /customers/{customerNumber} | Kundendetails auslesen |
getCustomerBillingRecipient | GET /customers/{customerNumber}/billingrecipient | Rechungsempfänger auslesen |
getCustomerBillingSettings | GET /customers/{customerNumber}/billingsettings | Rechungseinstellungen auslesen |
getCustomerContactPerson | GET /customers/{customerNumber}/contactperson | Ansprechpartner auslesen |
getCustomerContractPartner | GET /customers/{customerNumber}/contractpartner | Vertragspartner auslesen |
getCustomerPaymentSettings | GET /customers/{customerNumber}/paymentsettings | Zahlungseinstellungen auslesen |
getInvoice | GET /invoices/{invoiceNumber} | Rechnung eines Kunden |
getPaymentReceipts | GET /invoices/{invoiceNumber}/paymentreceipts | Zahlungseingänge einer Rechnung |
listAccountsByCustomer | GET /customers/{customerNumber}/accounts | Accounts eines Kunden |
listInvoicesByCustomer | GET /customers/{customerNumber}/invoices | Rechnungen eines Kunden |
resetCustomerBillingRecipient | DELETE /customers/{customerNumber}/billingrecipient | Rechnungsempfänger eines Kunden zurücksetzen |
updateCustomerBillingRecipient | PUT /customers/{customerNumber}/billingrecipient | Rechnungsempfänger ändern |
updateCustomerBillingSettings | PUT /customers/{customerNumber}/billingsettings | Rechnungseinstellungen ändern |
updateCustomerContactPerson | PUT /customers/{customerNumber}/contactperson | Ansprechpartner ändern |
updateCustomerContractPartner | PUT /customers/{customerNumber}/contractpartner | Vertragspartner ändern |
updateCustomerPaymentSettings | PUT /customers/{customerNumber}/paymentsettings | Zahlungseinstellungen ändern |
\Mittwald\Api\Model\Benefit[] getBenefitDetails($customer_number, $benefit)
Details zu einer gebuchten Leistung
Liefert Details zu einer gebuchten Leistung.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
$benefit = "benefit_example"; // string | Leistung
try {
$result = $apiInstance->getBenefitDetails($customer_number, $benefit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getBenefitDetails: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer | |
benefit | string | Leistung |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\Customer getCurrentCustomer()
Details zu dem aktuellem Kunden
Liefert Details zum aktuellen Kunden.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
try {
$result = $apiInstance->getCurrentCustomer();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCurrentCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\Customer getCustomer($customer_number)
Kundendetails auslesen
Diese Ressource enthält Detailinformationen zu einem bestimmten Kunden.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomer($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner getCustomerBillingRecipient($customer_number)
Rechungsempfänger auslesen
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomerBillingRecipient($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomerBillingRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerBillingSettings getCustomerBillingSettings($customer_number)
Rechungseinstellungen auslesen
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomerBillingSettings($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomerBillingSettings: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerBillingSettings
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner getCustomerContactPerson($customer_number)
Ansprechpartner auslesen
Diese Operation liefert Details zum Ansprechpartner eines Kunden zurück. Der Ansprechpartner kann identisch mit dem Vertragspartner sein; in diesem Fall wird die Anfrage mit einem 303-Statuscode beantwortet, und der Location
-Header enthält die URL des Vertragspartners, der in diesem Fall als Ansprechpartner gilt.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomerContactPerson($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomerContactPerson: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner getCustomerContractPartner($customer_number)
Vertragspartner auslesen
Diese Operation liefert Details zum Vertragspartner eines Kunden zurück
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomerContractPartner($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomerContractPartner: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPaymentSettings getCustomerPaymentSettings($customer_number)
Zahlungseinstellungen auslesen
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->getCustomerPaymentSettings($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getCustomerPaymentSettings: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPaymentSettings
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\Invoice getInvoice($invoice_number, $accept)
Rechnung eines Kunden
Diese Ressource repräsentiert eine einzelne Rechnung. Über den Accept
-Header kann gesteuert werden, ob die Daten dieser Rechnung als JSON-Dokument oder das tatsächliche Rechnungsdokument als PDF abgerufen werden sollen.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$invoice_number = 56; // int | Rechnungsnummer
$accept = new \Mittwald\Api\Model\null(); // | Das erwünschte Format (`application/json` oder `application/pdf`)
try {
$result = $apiInstance->getInvoice($invoice_number, $accept);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getInvoice: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoice_number | int | Rechnungsnummer | |
accept | **** | Das erwünschte Format (`application/json` oder `application/pdf`) | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\PaymentReceipt[] getPaymentReceipts($invoice_number)
Zahlungseingänge einer Rechnung
Liest erfasste Buchungen zu einer bestimmten Rechnung aus
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$invoice_number = 56; // int | Rechnungsnummer
try {
$result = $apiInstance->getPaymentReceipts($invoice_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->getPaymentReceipts: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoice_number | int | Rechnungsnummer |
\Mittwald\Api\Model\PaymentReceipt[]
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\Account[] listAccountsByCustomer($customer_number, $advised, $owned)
Accounts eines Kunden
Diese Ressource enthält eine Sammlung aller Accounts eines Kunden.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
$advised = false; // bool | Dieser Parameter steuert, ob auch Accounts zurückgeliefert werden sollen, für die eine Verwaltungsfreigabe besteht, aber nicht zur Kundennummer `{customerNumber}` gehören.'
$owned = true; // bool | Dieser Parameter steuert, ob Accounts zurückgeliefert werden sollen, die direkt der Kundennummer `{customerNumber}` gehören. Dieser Parameter hat standardmäßig den Wert `true`; über den Wert `false` können in Kombination mit dem Parameter `advised` ausschließlich Accounts abgefragt werden, für die eine Verwaltungsfreigabe besteht.
try {
$result = $apiInstance->listAccountsByCustomer($customer_number, $advised, $owned);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->listAccountsByCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer | |
advised | bool | Dieser Parameter steuert, ob auch Accounts zurückgeliefert werden sollen, für die eine Verwaltungsfreigabe besteht, aber nicht zur Kundennummer `{customerNumber}` gehören.' | [optional] [default to false] |
owned | bool | Dieser Parameter steuert, ob Accounts zurückgeliefert werden sollen, die direkt der Kundennummer `{customerNumber}` gehören. Dieser Parameter hat standardmäßig den Wert `true`; über den Wert `false` können in Kombination mit dem Parameter `advised` ausschließlich Accounts abgefragt werden, für die eine Verwaltungsfreigabe besteht. | [optional] [default to true] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\Invoice[] listInvoicesByCustomer($customer_number)
Rechnungen eines Kunden
Diese Ressource enthält eine Sammlung aller Rechnungen eines Kunden
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->listInvoicesByCustomer($customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->listInvoicesByCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
resetCustomerBillingRecipient($customer_number)
Rechnungsempfänger eines Kunden zurücksetzen
Diese Operation setzt den Rechnungsempfänger eines Kunden auf den Vertragspartner zurück
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$customer_number = 56; // int | Kundennummer
try {
$apiInstance->resetCustomerBillingRecipient($customer_number);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->resetCustomerBillingRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
customer_number | int | Kundennummer |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner updateCustomerBillingRecipient($body, $customer_number)
Rechnungsempfänger ändern
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$body = new \Mittwald\Api\Model\CustomerPartner(); // \Mittwald\Api\Model\CustomerPartner | Neuer Rechnungsempfänger
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->updateCustomerBillingRecipient($body, $customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->updateCustomerBillingRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Mittwald\Api\Model\CustomerPartner | Neuer Rechnungsempfänger | |
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerBillingSettings updateCustomerBillingSettings($body, $customer_number)
Rechnungseinstellungen ändern
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$body = new \Mittwald\Api\Model\CustomerBillingSettings(); // \Mittwald\Api\Model\CustomerBillingSettings | Neue Zahlungseinstellungen
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->updateCustomerBillingSettings($body, $customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->updateCustomerBillingSettings: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Mittwald\Api\Model\CustomerBillingSettings | Neue Zahlungseinstellungen | |
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerBillingSettings
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner updateCustomerContactPerson($body, $customer_number)
Ansprechpartner ändern
Über diese Operation lassen sich die Daten des Ansprechpartners eines Kunden ändern. Dabei kann der Ansprechpartner über den Request-Body-Parameter "identicalToDefaultAddress" ebenfalls identisch zum Vertragspartner gesetzt werden.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$body = new \Mittwald\Api\Model\ContactUpdateRequest(); // \Mittwald\Api\Model\ContactUpdateRequest | Die zu ändernden Ansprechpartnerdaten
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->updateCustomerContactPerson($body, $customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->updateCustomerContactPerson: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Mittwald\Api\Model\ContactUpdateRequest | Die zu ändernden Ansprechpartnerdaten | |
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPartner updateCustomerContractPartner($body, $customer_number)
Vertragspartner ändern
Über diese Operation können die Vertragspartnerdaten eines Kunden geändert werden
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$body = new \Mittwald\Api\Model\UpdateContact(); // \Mittwald\Api\Model\UpdateContact | Die zu ändernden Vertragspartnerdaten
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->updateCustomerContractPartner($body, $customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->updateCustomerContractPartner: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Mittwald\Api\Model\UpdateContact | Die zu ändernden Vertragspartnerdaten | |
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPartner
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Mittwald\Api\Model\CustomerPaymentSettings updateCustomerPaymentSettings($body, $customer_number)
Zahlungseinstellungen ändern
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Mittwald\Api\Functions\KundenApi(
// 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()
);
$body = new \Mittwald\Api\Model\CustomerPaymentSettings(); // \Mittwald\Api\Model\CustomerPaymentSettings | Neue Zahlungseinstellungen
$customer_number = 56; // int | Kundennummer
try {
$result = $apiInstance->updateCustomerPaymentSettings($body, $customer_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling KundenApi->updateCustomerPaymentSettings: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Mittwald\Api\Model\CustomerPaymentSettings | Neue Zahlungseinstellungen | |
customer_number | int | Kundennummer |
\Mittwald\Api\Model\CustomerPaymentSettings
No authorization required
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]