billingo-client

Billingo API v3

• API version: 3.0.14
  • Build date: 2023-10-15T09:59:06.459642900+02:00[Europe/Budapest]

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.

For more information, please visit https://www.billingo.hu/kapcsolat

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.clientapi</groupId>
  <artifactId>billingo-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'billingo-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'billingo-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.clientapi:billingo-client:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/billingo-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.BankAccountApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    BankAccountApi apiInstance = new BankAccountApi(defaultClient);
    BankAccount bankAccount = new BankAccount(); // BankAccount | BankAccount object that you would like to store.
    try {
      BankAccount result = apiInstance.createBankAccount(bankAccount);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BankAccountApi#createBankAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

• Address
• BankAccount
• BankAccountList
• Category
• CheckTaxNumberMessage
• ClientError
• ClientErrorResponse
• ConversationRate
• CorrectionType
• Country
• CreateDocumentExport
• Currency
• DateType
• Discount
• DiscountType
• Document
• DocumentAncestor
• DocumentBankAccount
• DocumentBlock
• DocumentBlockList
• DocumentBlockType
• DocumentCancellation
• DocumentExportFilterExtra
• DocumentExportId
• DocumentExportOtherOptions
• DocumentExportQueryType
• DocumentExportSortBy
• DocumentExportStatus
• DocumentExportStatusState
• DocumentExportType
• DocumentForm
• DocumentFormat
• DocumentInsert
• DocumentInsertItemsInner
• DocumentInsertType
• DocumentItem
• DocumentItemData
• DocumentLanguage
• DocumentList
• DocumentNotificationStatus
• DocumentOrganization
• DocumentPartner
• DocumentProductData
• DocumentPublicUrl
• DocumentSettings
• DocumentSummary
• DocumentType
• DocumentVatRateSummary
• Entitlement
• Feature
• Id
• InvoiceSettings
• LedgerNumberInformation
• ModificationDocumentInsert
• OnlinePayment
• OnlineSzamlaStatus
• OnlineSzamlaStatusEnum
• OnlineSzamlaStatusMessage
• OrganizationData
• Partner
• PartnerCustomBillingSettings
• PartnerList
• PartnerTaxType
• PaymentHistory
• PaymentMethod
• PaymentStatus
• PaymentStatusSpending
• Product
• ProductList
• ReceiptInsert
• ReceiptInsertItemsInner
• ReceiptItemData
• ReceiptProductData
• Round
• SendDocument
• ServerError
• ServerErrorResponse
• ServerTime
• Source
• Spending
• SpendingList
• SpendingListItem
• SpendingPartner
• SpendingPaymentMethod
• SpendingSave
• Subscription
• SubscriptionErrorResponse
• TaxNumber
• TooManyRequestsResponse
• UnitPriceType
• ValidationError
• ValidationErrorResponse
• Vat

Documentation for Authorization

Authentication schemes defined for the API:

api_key

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]