OpenAPI\Client\PartiesApi

All URIs are relative to https://topal.vitan.ch:9001, except if the operation defines another base path.

Method	HTTP request	Description
partiesDelete()	DELETE /api/v1/clients/{clientId}/parties/{id}	Delete party by id
partiesDeleteCreditor()	DELETE /api/v1/clients/{clientId}/parties/{id}/creditor	Delete creditor by party id
partiesDeleteDebtor()	DELETE /api/v1/clients/{clientId}/parties/{id}/debtor	Delete debtor by party id
partiesGet()	GET /api/v1/clients/{clientId}/parties	Retreives list of parties
partiesGetByFreeNumber()	GET /api/v1/clients/{clientId}/parties/byfreenumber/{freePartyNum}	Get party by freePartyNum
partiesGetByNumber()	GET /api/v1/clients/{clientId}/parties/bynumber/{partyNum}	Get party by partyNum
partiesGet_0()	GET /api/v1/clients/{clientId}/parties/{id}	Get party by id
partiesPost()	POST /api/v1/clients/{clientId}/parties	Save party
partiesPost_0()	POST /api/v1/clients/{clientId}/parties/{id}/creditor	Assign creditor to party creditor
partiesPost_1()	POST /api/v1/clients/{clientId}/parties/{id}/debtor	Assign debtor to party

`partiesDelete()`

partiesDelete($id, $client_id): object

Delete party by id

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesDeleteCreditor()`

partiesDeleteCreditor($id, $client_id): object

Delete creditor by party id

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesDeleteDebtor()`

partiesDeleteDebtor($id, $client_id): object

Delete debtor by party id

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesGet()`

partiesGet($client_id): \Topal\Client\Model\Party[]

Retreives list of parties

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string

Return type

\Topal\Client\Model\Party[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesGetByFreeNumber()`

partiesGetByFreeNumber($free_party_num, $client_id): \Topal\Client\Model\Party

Get party by freePartyNum

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$free_party_num = 'free_party_num_example'; // string
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
free_party_num	string
client_id	string

Return type

\Topal\Client\Model\Party

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesGetByNumber()`

partiesGetByNumber($party_num, $client_id): \Topal\Client\Model\Party

Get party by partyNum

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$party_num = 56; // int
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
party_num	int
client_id	string

Return type

\Topal\Client\Model\Party

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesGet_0()`

partiesGet_0($id, $client_id): \Topal\Client\Model\Party

Get party by id

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string

Return type

\Topal\Client\Model\Party

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

`partiesPost()`

partiesPost($client_id, $party): \Topal\Client\Model\Party

Save party

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$client_id = 'client_id_example'; // string
$party = new \Topal\Client\Model\Party(); // \Topal\Client\Model\Party

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

Parameters

Name	Type	Description	Notes
client_id	string
party	\Topal\Client\Model\Party

Return type

\Topal\Client\Model\Party

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

`partiesPost_0()`

partiesPost_0($id, $client_id, $creditor): \Topal\Client\Model\Creditor

Assign creditor to party creditor

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string
$creditor = new \Topal\Client\Model\Creditor(); // \Topal\Client\Model\Creditor

try {
    $result = $apiInstance->partiesPost_0($id, $client_id, $creditor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->partiesPost_0: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int
client_id	string
creditor	\Topal\Client\Model\Creditor

Return type

\Topal\Client\Model\Creditor

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

`partiesPost_1()`

partiesPost_1($id, $client_id, $debtor): \Topal\Client\Model\Debtor

Assign debtor to party

Example

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



$apiInstance = new Topal\Client\Api\PartiesApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string
$debtor = new \Topal\Client\Model\Debtor(); // \Topal\Client\Model\Debtor

try {
    $result = $apiInstance->partiesPost_1($id, $client_id, $debtor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->partiesPost_1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int
client_id	string
debtor	\Topal\Client\Model\Debtor

Return type

\Topal\Client\Model\Debtor

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

Files

PartiesApi.md

Latest commit

History

PartiesApi.md

File metadata and controls

OpenAPI\Client\PartiesApi

partiesDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesDeleteCreditor()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesDeleteDebtor()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesGetByFreeNumber()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesGetByNumber()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesGet_0()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesPost()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesPost_0()

Example

Parameters

Return type

Authorization

HTTP request headers

partiesPost_1()

Example

Parameters

Return type

Authorization

HTTP request headers

`partiesDelete()`

`partiesDeleteCreditor()`

`partiesDeleteDebtor()`

`partiesGet()`

`partiesGetByFreeNumber()`

`partiesGetByNumber()`

`partiesGet_0()`

`partiesPost()`

`partiesPost_0()`

`partiesPost_1()`