OpenAPI\Client\ReceivablesApi

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

Method	HTTP request	Description
receivablesDelete()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/{id}	Delete receivables invoice by id
receivablesDeleteDocument()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/{id}/document	delete document
receivablesDeleteManualPayment()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/manualpayments/{id}	delete manualPayment by id
receivablesDownloadDocument()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/{id}/document	download document
receivablesGet()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices	Retreives list of receivables invoices
receivablesGetAll()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/all	Retreives list of receivables invoices
receivablesGetAllPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/parties/{id}/invoices/all	Retreives list of party all receivables invoices
receivablesGetByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/byfreeinvoicenum/{freeInvoiceNum}	Get receivables invoice by freeInvoiceNum, return error if there is more than one invoice with this number
receivablesGetByFreeInvoicesNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/byfreeinvoicenum/{freeInvoiceNum}/all	Get list of receivables invoices by freeInvoiceNum
receivablesGetByInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/byinvoicenum/{invoiceNum}	Get receivables invoice by invoiceNum
receivablesGetInvoicesByPeriod()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/byperiod	Retreives list of receivables invoices by period
receivablesGetManualPayment()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/manualpayments/{id}	get manualPayment by id
receivablesGetManualPayments()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/manualpayments	Retreives list of Manual Payments
receivablesGetOpen()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/open	Retreives list of receivables invoices
receivablesGetOpenInvoicesByPeriod()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/open/byperiod	Retreives list of receivables invoices by period
receivablesGetOpenPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/parties/{id}/invoices/open	Retreives list of party open receivables invoices
receivablesGetPartyInvoiceByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/parties/{partyID}/invoices/byfreeinvoicenum/{freeInvoiceNum}	Get receivables invoice by party ID and freeInvoiceNum, return error if there is more than one invoice with this number
receivablesGetPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/parties/{id}/invoices	Retreives list of party receivables invoices
receivablesGetPartyInvoicesByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/parties/{partyID}/invoices/byfreeinvoicenum/{freeInvoiceNum}/all	Get list of receivables invoices by partyFID freeInvoiceNum
receivablesGet_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/{id}	Get receivables invoice by id
receivablesLinkDocument()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/{id}/document	link document
receivablesNew()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/new	creates new invoice
receivablesPayInvoice()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices/{id}/pay	pay invoice by id
receivablesPost()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/invoices	Save receivables invouce
receivablesPostManualPayment()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/receivables/manualpayments	saves manualPayment

`receivablesDelete()`

receivablesDelete($id, $client_id, $fiscal_year_id): object

Delete receivables invoice by id

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_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]

`receivablesDeleteDocument()`

receivablesDeleteDocument($id, $client_id, $fiscal_year_id): object

delete document

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_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]

`receivablesDeleteManualPayment()`

receivablesDeleteManualPayment($id, $client_id, $fiscal_year_id): object

delete manualPayment by id

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_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]

`receivablesDownloadDocument()`

receivablesDownloadDocument($id, $client_id, $fiscal_year_id): object

download document

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_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]

`receivablesGet()`

receivablesGet($only_open, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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()
);
$only_open = True; // bool
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
only_open	bool
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetAll()`

receivablesGetAll($client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetAllPartyInvoices()`

receivablesGetAllPartyInvoices($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of party all receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetByFreeInvoiceNum()`

receivablesGetByFreeInvoiceNum($free_invoice_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice

Get receivables invoice by freeInvoiceNum, return error if there is more than one invoice with this number

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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_invoice_num = 'free_invoice_num_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
free_invoice_num	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice

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]

`receivablesGetByFreeInvoicesNum()`

receivablesGetByFreeInvoicesNum($free_invoice_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Get list of receivables invoices by freeInvoiceNum

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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_invoice_num = 'free_invoice_num_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
free_invoice_num	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetByInvoiceNum()`

receivablesGetByInvoiceNum($invoice_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice

Get receivables invoice by invoiceNum

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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_num = 56; // int
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
invoice_num	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice

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]

`receivablesGetInvoicesByPeriod()`

receivablesGetInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of receivables invoices by period

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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()
);
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$date_until = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->receivablesGetInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceivablesApi->receivablesGetInvoicesByPeriod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
date_from	\DateTime
date_until	\DateTime
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetManualPayment()`

receivablesGetManualPayment($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Payment

get manualPayment by id

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Payment

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]

`receivablesGetManualPayments()`

receivablesGetManualPayments($client_id, $fiscal_year_id): \Topal\Client\Model\Payment[]

Retreives list of Manual Payments

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Payment[]

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]

`receivablesGetOpen()`

receivablesGetOpen($client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetOpenInvoicesByPeriod()`

receivablesGetOpenInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of receivables invoices by period

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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()
);
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$date_until = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->receivablesGetOpenInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceivablesApi->receivablesGetOpenInvoicesByPeriod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
date_from	\DateTime
date_until	\DateTime
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetOpenPartyInvoices()`

receivablesGetOpenPartyInvoices($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of party open receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetPartyInvoiceByFreeInvoiceNum()`

receivablesGetPartyInvoiceByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice

Get receivables invoice by party ID and freeInvoiceNum, return error if there is more than one invoice with this number

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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_id = 56; // int
$free_invoice_num = 'free_invoice_num_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->receivablesGetPartyInvoiceByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceivablesApi->receivablesGetPartyInvoiceByFreeInvoiceNum: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
party_id	int
free_invoice_num	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice

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]

`receivablesGetPartyInvoices()`

receivablesGetPartyInvoices($id, $only_open, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Retreives list of party receivables invoices

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$only_open = True; // bool
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
only_open	bool
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGetPartyInvoicesByFreeInvoiceNum()`

receivablesGetPartyInvoicesByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice[]

Get list of receivables invoices by partyFID freeInvoiceNum

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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_id = 56; // int
$free_invoice_num = 'free_invoice_num_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->receivablesGetPartyInvoicesByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceivablesApi->receivablesGetPartyInvoicesByFreeInvoiceNum: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
party_id	int
free_invoice_num	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice[]

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]

`receivablesGet_0()`

receivablesGet_0($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Invoice

Get receivables invoice by id

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice

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]

`receivablesLinkDocument()`

receivablesLinkDocument($id, $client_id, $fiscal_year_id): object

link document

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_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]

`receivablesNew()`

receivablesNew($client_id, $fiscal_year_id): \Topal\Client\Model\Invoice

creates new invoice

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Invoice

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]

`receivablesPayInvoice()`

receivablesPayInvoice($id, $date, $client_id, $fiscal_year_id): \Topal\Client\Model\Payment

pay invoice by id

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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 = 'id_example'; // string
$date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string
date	\DateTime
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Payment

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]

`receivablesPost()`

receivablesPost($client_id, $fiscal_year_id, $invoice): \Topal\Client\Model\Invoice

Save receivables invouce

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string
$invoice = new \Topal\Client\Model\Invoice(); // \Topal\Client\Model\Invoice

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string
invoice	\Topal\Client\Model\Invoice

Return type

\Topal\Client\Model\Invoice

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]

`receivablesPostManualPayment()`

receivablesPostManualPayment($client_id, $fiscal_year_id, $payment): \Topal\Client\Model\Payment

saves manualPayment

Example

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



$apiInstance = new Topal\Client\Api\ReceivablesApi(
    // 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
$fiscal_year_id = 'fiscal_year_id_example'; // string
$payment = new \Topal\Client\Model\Payment(); // \Topal\Client\Model\Payment

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string
payment	\Topal\Client\Model\Payment

Return type

\Topal\Client\Model\Payment

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]

FilesExpand file tree

ReceivablesApi.md

Latest commit

History

ReceivablesApi.md

File metadata and controls

OpenAPI\Client\ReceivablesApi

receivablesDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesDeleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesDeleteManualPayment()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesDownloadDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetAllPartyInvoices()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetByFreeInvoiceNum()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetByFreeInvoicesNum()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetByInvoiceNum()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetInvoicesByPeriod()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetManualPayment()

Example

Parameters

Return type

Authorization

HTTP request headers

receivablesGetManualPayments()

`receivablesDelete()`

`receivablesDeleteDocument()`

`receivablesDeleteManualPayment()`

`receivablesDownloadDocument()`

`receivablesGet()`

`receivablesGetAll()`

`receivablesGetAllPartyInvoices()`

`receivablesGetByFreeInvoiceNum()`

`receivablesGetByFreeInvoicesNum()`

`receivablesGetByInvoiceNum()`

`receivablesGetInvoicesByPeriod()`

`receivablesGetManualPayment()`

`receivablesGetManualPayments()`

`receivablesGetOpen()`

`receivablesGetOpenInvoicesByPeriod()`

`receivablesGetOpenPartyInvoices()`

`receivablesGetPartyInvoiceByFreeInvoiceNum()`

`receivablesGetPartyInvoices()`

`receivablesGetPartyInvoicesByFreeInvoiceNum()`

`receivablesGet_0()`

`receivablesLinkDocument()`

`receivablesNew()`

`receivablesPayInvoice()`