OpenAPI\Client\PayablesApi

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

Method	HTTP request	Description
payablesDelete()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/{id}	Delete payables invoice by id
payablesDeleteDocument()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/{id}/document	delete document
payablesDeleteManualPayment()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/manualpayments/{id}	delete manualPayment by id
payablesDownloadDocument()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/{id}/document	download document
payablesGet()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices	Retreives list of payables invoices
payablesGetAll()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/all	Retreives list of payables invoices
payablesGetAllPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/parties/{id}/invoices/all	Retreives list of party all payables invoices
payablesGetByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/byfreeinvoicenum/{freeInvoiceNum}	Get payables invoice by freeInvoiceNum, return error if there is more than one invoice with this number
payablesGetByFreeInvoicesNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/byfreeinvoicenum/{freeInvoiceNum}/all	Get list of payables invoices by freeInvoiceNum
payablesGetByInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/byinvoicenum/{invoiceNum}	Get payables invoice by invoiceNum
payablesGetInvoicesByPeriod()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/byperiod	Retreives list of payables invoices by period
payablesGetManualPayment()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/manualpayments/{id}	get manualPayment by id
payablesGetManualPayments()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/manualpayments	Retreives list of Manual Payments
payablesGetOpen()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/open	Retreives list of payables invoices
payablesGetOpenInvoicesByPeriod()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/open/byperiod	Retreives list of payables invoices by period
payablesGetOpenPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/parties/{id}/invoices/open	Retreives list of party open payables invoices
payablesGetPartyInvoiceByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/parties/{partyID}/invoices/byfreeinvoicenum/{freeInvoiceNum}	Get payables invoice by party ID and freeInvoiceNum, return error if there is more than one invoice with this number
payablesGetPartyInvoices()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/parties/{id}/invoices	Retreives list of party payables invoices
payablesGetPartyInvoicesByFreeInvoiceNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/parties/{partyID}/invoices/byfreeinvoicenum/{freeInvoiceNum}/all	Get list of payables invoices by partyFID freeInvoiceNum
payablesGetPendingDocuments()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/documents/pending	get not procssed documents from dms
payablesGet_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/{id}	Get payables invoice by id
payablesLinkDocument()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/{id}/document	link document
payablesNew()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/new	creates new invoice
payablesPayInvoice()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/{id}/pay	pay invoice by id
payablesPost()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices	Save payables invouce
payablesPostFromQrBill()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/invoices/qrbill	Creates payables invoice out of QrBill
payablesPostManualPayment()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/manualpayments	saves manualPayment
payablesUpload()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/payables/documents	create invoice from qrBill and save document to DMS

`payablesDelete()`

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

Delete payables invoice by id

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesDelete($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesDelete: ', $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]

`payablesDeleteDocument()`

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

delete document

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesDeleteDocument($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesDeleteDocument: ', $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]

`payablesDeleteManualPayment()`

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

delete manualPayment by id

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesDeleteManualPayment($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesDeleteManualPayment: ', $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]

`payablesDownloadDocument()`

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

download document

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesDownloadDocument($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesDownloadDocument: ', $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]

`payablesGet()`

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

Retreives list of payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGet($only_open, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGet: ', $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]

`payablesGetAll()`

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

Retreives list of payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetAll($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetAll: ', $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]

`payablesGetAllPartyInvoices()`

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

Retreives list of party all payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetAllPartyInvoices($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetAllPartyInvoices: ', $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]

`payablesGetByFreeInvoiceNum()`

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

Get payables 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\PayablesApi(
    // 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->payablesGetByFreeInvoiceNum($free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetByFreeInvoiceNum: ', $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]

`payablesGetByFreeInvoicesNum()`

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

Get list of payables invoices by freeInvoiceNum

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetByFreeInvoicesNum($free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetByFreeInvoicesNum: ', $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]

`payablesGetByInvoiceNum()`

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

Get payables invoice by invoiceNum

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetByInvoiceNum($invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetByInvoiceNum: ', $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]

`payablesGetInvoicesByPeriod()`

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

Retreives list of payables invoices by period

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetInvoicesByPeriod: ', $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]

`payablesGetManualPayment()`

payablesGetManualPayment($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\PayablesApi(
    // 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->payablesGetManualPayment($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetManualPayment: ', $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]

`payablesGetManualPayments()`

payablesGetManualPayments($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\PayablesApi(
    // 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->payablesGetManualPayments($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetManualPayments: ', $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]

`payablesGetOpen()`

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

Retreives list of payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetOpen($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetOpen: ', $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]

`payablesGetOpenInvoicesByPeriod()`

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

Retreives list of payables invoices by period

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetOpenInvoicesByPeriod($date_from, $date_until, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetOpenInvoicesByPeriod: ', $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]

`payablesGetOpenPartyInvoices()`

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

Retreives list of party open payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetOpenPartyInvoices($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetOpenPartyInvoices: ', $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]

`payablesGetPartyInvoiceByFreeInvoiceNum()`

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

Get payables 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\PayablesApi(
    // 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->payablesGetPartyInvoiceByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetPartyInvoiceByFreeInvoiceNum: ', $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]

`payablesGetPartyInvoices()`

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

Retreives list of party payables invoices

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetPartyInvoices($id, $only_open, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetPartyInvoices: ', $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]

`payablesGetPartyInvoicesByFreeInvoiceNum()`

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

Get list of payables invoices by partyFID freeInvoiceNum

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetPartyInvoicesByFreeInvoiceNum($party_id, $free_invoice_num, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetPartyInvoicesByFreeInvoiceNum: ', $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]

`payablesGetPendingDocuments()`

payablesGetPendingDocuments($client_id, $fiscal_year_id): \Topal\Client\Model\Document[]

get not procssed documents from dms

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGetPendingDocuments($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGetPendingDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Document[]

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]

`payablesGet_0()`

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

Get payables invoice by id

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesGet_0($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesGet_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]

`payablesLinkDocument()`

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

link document

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesLinkDocument($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesLinkDocument: ', $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]

`payablesNew()`

payablesNew($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\PayablesApi(
    // 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->payablesNew($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesNew: ', $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]

`payablesPayInvoice()`

payablesPayInvoice($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\PayablesApi(
    // 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->payablesPayInvoice($id, $date, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesPayInvoice: ', $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]

`payablesPost()`

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

Save payables invouce

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesPost($client_id, $fiscal_year_id, $invoice);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesPost: ', $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]

`payablesPostFromQrBill()`

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

Creates payables invoice out of QrBill

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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
$qr_bill = new \Topal\Client\Model\QrBill(); // \Topal\Client\Model\QrBill

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string
qr_bill	\Topal\Client\Model\QrBill

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]

`payablesPostManualPayment()`

payablesPostManualPayment($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\PayablesApi(
    // 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->payablesPostManualPayment($client_id, $fiscal_year_id, $payment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesPostManualPayment: ', $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]

`payablesUpload()`

payablesUpload($client_id, $fiscal_year_id): object

create invoice from qrBill and save document to DMS

Example

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



$apiInstance = new Topal\Client\Api\PayablesApi(
    // 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->payablesUpload($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayablesApi->payablesUpload: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
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]

Files

PayablesApi.md

Latest commit

History

PayablesApi.md

File metadata and controls

OpenAPI\Client\PayablesApi

payablesDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesDeleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesDeleteManualPayment()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesDownloadDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetAllPartyInvoices()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetByFreeInvoiceNum()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetByFreeInvoicesNum()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetByInvoiceNum()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetInvoicesByPeriod()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetManualPayment()

Example

Parameters

Return type

Authorization

HTTP request headers

payablesGetManualPayments()

`payablesDelete()`

`payablesDeleteDocument()`

`payablesDeleteManualPayment()`

`payablesDownloadDocument()`

`payablesGet()`

`payablesGetAll()`

`payablesGetAllPartyInvoices()`

`payablesGetByFreeInvoiceNum()`

`payablesGetByFreeInvoicesNum()`

`payablesGetByInvoiceNum()`

`payablesGetInvoicesByPeriod()`

`payablesGetManualPayment()`

`payablesGetManualPayments()`

`payablesGetOpen()`

`payablesGetOpenInvoicesByPeriod()`

`payablesGetOpenPartyInvoices()`

`payablesGetPartyInvoiceByFreeInvoiceNum()`

`payablesGetPartyInvoices()`

`payablesGetPartyInvoicesByFreeInvoiceNum()`

`payablesGetPendingDocuments()`

`payablesGet_0()`

`payablesLinkDocument()`

`payablesNew()`