alphaws / billingo-api-v3
Billingo Invoice aPI clone from Swagger Hub
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.0.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-10-20 08:07:36 UTC
README
This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request bodies and returns JSON-encoded responses. To use this API you have to generate a new API key on our site. After that, you can test your API key on this page.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 3.0.14
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://www.billingo.hu/kapcsolat
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api_key $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); $apiInstance = new Swagger\Client\Api\BankAccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \Swagger\Client\Model\BankAccount(); // \Swagger\Client\Model\BankAccount | BankAccount object that you would like to store. try { $result = $apiInstance->createBankAccount($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling BankAccountApi->createBankAccount: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: api_key $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); $apiInstance = new Swagger\Client\Api\BankAccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = 56; // int | try { $apiInstance->deleteBankAccount($id); } catch (Exception $e) { echo 'Exception when calling BankAccountApi->deleteBankAccount: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: api_key $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); $apiInstance = new Swagger\Client\Api\BankAccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = 56; // int | try { $result = $apiInstance->getBankAccount($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BankAccountApi->getBankAccount: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: api_key $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); $apiInstance = new Swagger\Client\Api\BankAccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $page = 56; // int | $per_page = 25; // int | try { $result = $apiInstance->listBankAccount($page, $per_page); print_r($result); } catch (Exception $e) { echo 'Exception when calling BankAccountApi->listBankAccount: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: api_key $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); $apiInstance = new Swagger\Client\Api\BankAccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \Swagger\Client\Model\BankAccount(); // \Swagger\Client\Model\BankAccount | Bank account object that you would like to update. $id = 56; // int | try { $result = $apiInstance->updateBankAccount($body, $id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BankAccountApi->updateBankAccount: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://api.billingo.hu/v3
Documentation For Models
- Address
- BankAccount
- BankAccountList
- Category
- CheckTaxNumberMessage
- ClientError
- ClientErrorResponse
- ConversationRate
- CorrectionType
- Country
- CreateDocumentExport
- Currency
- Discount
- DiscountType
- Document
- DocumentAncestor
- DocumentBankAccount
- DocumentBlock
- DocumentBlockList
- DocumentCancellation
- DocumentExportFilterExtra
- DocumentExportId
- DocumentExportOtherOptions
- DocumentExportQueryType
- DocumentExportSortBy
- DocumentExportStatus
- DocumentExportStatusState
- DocumentExportType
- DocumentForm
- DocumentFormat
- DocumentInsert
- DocumentInsertType
- DocumentItem
- DocumentItemData
- DocumentLanguage
- DocumentList
- DocumentNotificationStatus
- DocumentOrganization
- DocumentPartner
- DocumentProductData
- DocumentPublicUrl
- DocumentSettings
- DocumentSummary
- DocumentType
- DocumentVatRateSummary
- Entitlement
- Id
- InvoiceSettings
- LedgerNumberInformation
- ModificationDocumentInsert
- OneOfDocumentDiscount
- OneOfDocumentInsertDiscount
- OneOfDocumentInsertItemsItems
- OneOfInvoiceSettingsDocumentFormat
- OneOfInvoiceSettingsDocumentType
- OneOfModificationDocumentInsertItemsItems
- OnlinePayment
- OnlineSzamlaStatus
- OnlineSzamlaStatusEnum
- OnlineSzamlaStatusMessage
- OrganizationData
- Partner
- PartnerCustomBillingSettings
- PartnerList
- PartnerTaxType
- PaymentHistory
- PaymentMethod
- PaymentStatus
- Product
- ProductList
- Round
- SendDocument
- ServerError
- ServerErrorResponse
- Spending
- SpendingList
- SpendingListItem
- SpendingPartner
- SpendingPaymentMethod
- SpendingSave
- Subscription
- SubscriptionErrorResponse
- TaxNumber
- TooManyRequestsResponse
- UnitPriceType
- ValidationError
- ValidationErrorResponse
- Vat
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header