Skip to content

Latest commit

 

History

History
330 lines (285 loc) · 17.7 KB

README.md

File metadata and controls

330 lines (285 loc) · 17.7 KB
Raw

SwaggerClient-php

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:

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

Class Method HTTP request Description
BankAccountApi createBankAccount POST /bank-accounts Create a bank account
BankAccountApi deleteBankAccount DELETE /bank-accounts/{id} Delete a bank account
BankAccountApi getBankAccount GET /bank-accounts/{id} Retrieve a bank account
BankAccountApi listBankAccount GET /bank-accounts List all bank account
BankAccountApi updateBankAccount PUT /bank-accounts/{id} Update a bank account
CurrencyApi getConversionRate GET /currencies Get currencies exchange rate.
DocumentApi archiveDocument PUT /documents/{id}/archive Archive a proforma document.
DocumentApi cancelDocument POST /documents/{id}/cancel Cancel a document
DocumentApi createDocument POST /documents Create a document
DocumentApi createDocumentFromDraft PUT /documents/{id} Converts a draft to an invoice.
DocumentApi createDocumentFromProforma POST /documents/{id}/create-from-proforma Create a document from proforma.
DocumentApi createModificationDocument POST /documents/{id}/create-modification-document Create a modification document.
DocumentApi createReceipt POST /documents/receipt Create a receipt
DocumentApi createReceiptFromDraft PUT /documents/receipt/{id} Converts a draft to a receipt.
DocumentApi deleteDocument DELETE /documents/{id} Delete a draft.
DocumentApi deletePayment DELETE /documents/{id}/payments Delete all payment history on document
DocumentApi documentCopy POST /documents/{id}/copy Copy a document
DocumentApi downloadDocument GET /documents/{id}/download Download a document in PDF format.
DocumentApi getDocument GET /documents/{id} Retrieve a document
DocumentApi getDocumentByVendorId GET /documents/vendor/{vendor_id} Retrieve a document by vendor id
DocumentApi getOnlineSzamlaStatus GET /documents/{id}/online-szamla Retrieve a document Online Számla status
DocumentApi getPayment GET /documents/{id}/payments Retrieve a payment histroy
DocumentApi getPublicUrl GET /documents/{id}/public-url Retrieve a document download public url.
DocumentApi listDocument GET /documents List all documents
DocumentApi posPrint GET /documents/{id}/print/pos Returns a printable POS PDF
DocumentApi sendDocument POST /documents/{id}/send Send invoice to given email adresses.
DocumentApi updatePayment PUT /documents/{id}/payments Update payment history
DocumentBlockApi listDocumentBlock GET /document-blocks List all document blocks
DocumentExportApi create POST /document-export Create document export.
DocumentExportApi download GET /document-export/{id}/download Return exported binary file.
DocumentExportApi poll GET /document-export/{id}/poll Retrieve export state.
OrganizationApi getOrganizationData GET /organization Retrieve a organization data.
PartnerApi createPartner POST /partners Create a partner
PartnerApi deletePartner DELETE /partners/{id} Delete a partner
PartnerApi getPartner GET /partners/{id} Retrieve a partner
PartnerApi listPartner GET /partners List all partners
PartnerApi updatePartner PUT /partners/{id} Update a partner
ProductApi createProduct POST /products Create a product
ProductApi deleteProduct DELETE /products/{id} Delete a product
ProductApi getProduct GET /products/{id} Retrieve a product
ProductApi listProduct GET /products List all product
ProductApi updateProduct PUT /products/{id} Update a product
SpendingApi spendingDelete DELETE /spendings/{id} Deletes a spending.
SpendingApi spendingList GET /spendings Lists all spending
SpendingApi spendingSave POST /spendings Creates a new spending.
SpendingApi spendingShow GET /spendings/{id} Retrieves one specific spending.
SpendingApi spendingUpdate PUT /spendings/{id} Updates a spending item.
UtilApi checkTaxNumber GET /utils/check-tax-number/{tax_number} Check tax number.
UtilApi getId GET /utils/convert-legacy-id/{id} Convert legacy ID to v3 ID.
UtilApi getServerTime GET /utils/time Get the server time

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

[email protected]