DocumentApi

All URIs are relative to https://api.billingo.hu/v3

Method	HTTP request	Description
archiveDocument	PUT /documents/{id}/archive	Archive a proforma document.
cancelDocument	POST /documents/{id}/cancel	Cancel a document
createDocument	POST /documents	Create a document
createDocumentFromDraft	PUT /documents/{id}	Converts a draft to an invoice.
createDocumentFromProforma	POST /documents/{id}/create-from-proforma	Create a document from proforma.
createModificationDocument	POST /documents/{id}/create-modification-document	Create a modification document.
createReceipt	POST /documents/receipt	Create a receipt
createReceiptFromDraft	PUT /documents/receipt/{id}	Converts a draft to a receipt.
deleteDocument	DELETE /documents/{id}	Delete a draft.
deletePayment	DELETE /documents/{id}/payments	Delete all payment history on document
documentCopy	POST /documents/{id}/copy	Copy a document
downloadDocument	GET /documents/{id}/download	Download a document in PDF format.
getDocument	GET /documents/{id}	Retrieve a document
getDocumentByVendorId	GET /documents/vendor/{vendor_id}	Retrieve a document by vendor id
getOnlineSzamlaStatus	GET /documents/{id}/online-szamla	Retrieve a document Online Számla status
getPayment	GET /documents/{id}/payments	Retrieve a payment histroy
getPublicUrl	GET /documents/{id}/public-url	Retrieve a document download public url.
listDocument	GET /documents	List all documents
posPrint	GET /documents/{id}/print/pos	Returns a printable POS PDF
sendDocument	POST /documents/{id}/send	Send invoice to given email adresses.
updatePayment	PUT /documents/{id}/payments	Update payment history

archiveDocument

archiveDocument(id)

Archive a proforma document.

Archive an existing proforma document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      apiInstance.archiveDocument(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#archiveDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Document archived successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

cancelDocument

Document cancelDocument(id, documentCancellation)

Cancel a document

Cancel a document. Returns a cancellation document object if the cancellation is succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    DocumentCancellation documentCancellation = new DocumentCancellation(); // DocumentCancellation | Comment and notifiable email addresses - comma separated for multiple email addresses
    try {
      Document result = apiInstance.cancelDocument(id, documentCancellation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#cancelDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
documentCancellation	DocumentCancellation	Comment and notifiable email addresses - comma separated for multiple email addresses	[optional]

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document cancellation successfully. Cancel document returned.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createDocument

Document createDocument(documentInsert)

Create a document

Create a new document. Returns a document object if the create is succeded.

Example

// 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.DocumentApi;

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");

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

Parameters

Name	Type	Description	Notes
documentInsert	DocumentInsert	DocumentInsert object that you would like to store.

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document created successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createDocumentFromDraft

Document createDocumentFromDraft(id, documentInsert)

Converts a draft to an invoice.

Converts a draft to an invoice. Returns the invoice object if the convert is succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    DocumentInsert documentInsert = new DocumentInsert(); // DocumentInsert | DocumentInsert object that you would like to store.
    try {
      Document result = apiInstance.createDocumentFromDraft(id, documentInsert);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#createDocumentFromDraft");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
documentInsert	DocumentInsert	DocumentInsert object that you would like to store.

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Draft converted successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createDocumentFromProforma

Document createDocumentFromProforma(id, invoiceSettings)

Create a document from proforma.

Create a new document from proforma. Returns a document object if the create is succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    InvoiceSettings invoiceSettings = new InvoiceSettings(); // InvoiceSettings | InvoiceSettings object.
    try {
      Document result = apiInstance.createDocumentFromProforma(id, invoiceSettings);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#createDocumentFromProforma");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
invoiceSettings	InvoiceSettings	InvoiceSettings object.	[optional]

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document created successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createModificationDocument

Document createModificationDocument(id, modificationDocumentInsert)

Create a modification document.

Create a modification document for the given document. Returns a new document object if the create is successful.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    ModificationDocumentInsert modificationDocumentInsert = new ModificationDocumentInsert(); // ModificationDocumentInsert | ModificationDocumentInsert object that you would like to store.
    try {
      Document result = apiInstance.createModificationDocument(id, modificationDocumentInsert);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#createModificationDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
modificationDocumentInsert	ModificationDocumentInsert	ModificationDocumentInsert object that you would like to store.

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Modification document created successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createReceipt

Document createReceipt(receiptInsert)

Create a receipt

Create a new receipt. Returns a document object if the create is succeded.

Example

// 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.DocumentApi;

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");

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

Parameters

Name	Type	Description	Notes
receiptInsert	ReceiptInsert	ReceiptInsert object that you would like to store.

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Receipt created successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

createReceiptFromDraft

Document createReceiptFromDraft(id, receiptInsert)

Converts a draft to a receipt.

Converts a draft to a receipt. Returns the receipt object if the convert is succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    ReceiptInsert receiptInsert = new ReceiptInsert(); // ReceiptInsert | ReceiptInsert object that you would like to store.
    try {
      Document result = apiInstance.createReceiptFromDraft(id, receiptInsert);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#createReceiptFromDraft");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
receiptInsert	ReceiptInsert	ReceiptInsert object that you would like to store.

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Draft converted successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

deleteDocument

deleteDocument(id)

Delete a draft.

Delete an existing draft.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      apiInstance.deleteDocument(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#deleteDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Draft deleted successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

deletePayment

List<PaymentHistory> deletePayment(id)

Delete all payment history on document

Delete all exist payment history on document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      List<PaymentHistory> result = apiInstance.deletePayment(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#deletePayment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

List<PaymentHistory>

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Payment history deleted successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

documentCopy

Document documentCopy(id)

Copy a document

Copy a document. Returns the new document if the copy was succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      Document result = apiInstance.documentCopy(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#documentCopy");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document copied successfully. The created document returned.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

downloadDocument

File downloadDocument(id)

Download a document in PDF format.

Download a document. Returns a document in PDF format.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      File result = apiInstance.downloadDocument(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#downloadDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

File

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

HTTP response details

Status code	Description	Response headers
200	Document PDF file.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
202	Document PDF has not generated yet. You should try to download again later.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

getDocument

Document getDocument(id)

Retrieve a document

Retrieves the details of an existing document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      Document result = apiInstance.getDocument(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#getDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

getDocumentByVendorId

Document getDocumentByVendorId(vendorId)

Retrieve a document by vendor id

Retrieves the details of an existing document by vendor id.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    String vendorId = "vendorId_example"; // String | 
    try {
      Document result = apiInstance.getDocumentByVendorId(vendorId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#getDocumentByVendorId");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
vendorId	String

Return type

Document

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

getOnlineSzamlaStatus

OnlineSzamlaStatus getOnlineSzamlaStatus(id)

Retrieve a document Online Számla status

Retrieves the details of an existing document status.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      OnlineSzamlaStatus result = apiInstance.getOnlineSzamlaStatus(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#getOnlineSzamlaStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

OnlineSzamlaStatus

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

getPayment

List<PaymentHistory> getPayment(id)

Retrieve a payment histroy

Retrieves the details of payment history an existing document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      List<PaymentHistory> result = apiInstance.getPayment(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#getPayment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

List<PaymentHistory>

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

getPublicUrl

DocumentPublicUrl getPublicUrl(id)

Retrieve a document download public url.

Retrieves public url to download an existing document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      DocumentPublicUrl result = apiInstance.getPublicUrl(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#getPublicUrl");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

DocumentPublicUrl

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

listDocument

DocumentList listDocument(page, perPage, blockId, partnerId, paymentMethod, paymentStatus, startDate, endDate, startNumber, endNumber, startYear, endYear, type, query, paidStartDate, paidEndDate, fulfillmentStartDate, fulfillmentEndDate, lastModifiedDate)

List all documents

Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer page = 56; // Integer | 
    Integer perPage = 25; // Integer | 
    Integer blockId = 56; // Integer | Filter documents by the identifier of your DocumentBlock.
    Integer partnerId = 56; // Integer | Filter documents by the identifier of your Partner.
    PaymentMethod paymentMethod = PaymentMethod.fromValue("aruhitel"); // PaymentMethod | Filter documents by PaymentMethod value.
    PaymentStatus paymentStatus = PaymentStatus.fromValue("expired"); // PaymentStatus | Filter documents by PaymentStatus value.
    LocalDate startDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their invoice date.
    LocalDate endDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their invoice date.
    Integer startNumber = 1; // Integer | Starting number of the document, should not contain year or any other formatting. Required if `start_year` given
    Integer endNumber = 10; // Integer | Ending number of the document, should not contain year or any other formatting. Required if `end_year` given
    Integer startYear = 2020; // Integer | Year for `start_number` parameter. Required if `start_number` given.
    Integer endYear = 2020; // Integer | Year for `end_number` parameter. Required if `end_number` given.
    DocumentType type = DocumentType.fromValue("advance"); // DocumentType | Filter documents by type
    String query = "query_example"; // String | Filter documents by the given text
    LocalDate paidStartDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their payment date.
    LocalDate paidEndDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their payment date.
    LocalDate fulfillmentStartDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their fulfillment date.
    LocalDate fulfillmentEndDate = LocalDate.parse("2020-05-15"); // LocalDate | Filter documents by their fulfillment date.
    String lastModifiedDate = "2021-09-03 11:27:00"; // String | Filter documents by their last modified date.
    try {
      DocumentList result = apiInstance.listDocument(page, perPage, blockId, partnerId, paymentMethod, paymentStatus, startDate, endDate, startNumber, endNumber, startYear, endYear, type, query, paidStartDate, paidEndDate, fulfillmentStartDate, fulfillmentEndDate, lastModifiedDate);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#listDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
page	Integer		[optional]
perPage	Integer		[optional] [default to 25]
blockId	Integer	Filter documents by the identifier of your DocumentBlock.	[optional]
partnerId	Integer	Filter documents by the identifier of your Partner.	[optional]
paymentMethod	PaymentMethod	Filter documents by PaymentMethod value.	[optional] [enum: aruhitel, bankcard, barion, barter, cash, cash_on_delivery, coupon, elore_utalas, ep_kartya, kompenzacio, levonas, online_bankcard, other, paylike, payoneer, paypal, paypal_utolag, payu, pick_pack_pont, postai_csekk, postautalvany, skrill, szep_card, transferwise, upwork, utalvany, valto, wire_transfer]
paymentStatus	PaymentStatus	Filter documents by PaymentStatus value.	[optional] [enum: expired, none, outstanding, paid, partially_paid]
startDate	LocalDate	Filter documents by their invoice date.	[optional]
endDate	LocalDate	Filter documents by their invoice date.	[optional]
startNumber	Integer	Starting number of the document, should not contain year or any other formatting. Required if `start_year` given	[optional]
endNumber	Integer	Ending number of the document, should not contain year or any other formatting. Required if `end_year` given	[optional]
startYear	Integer	Year for `start_number` parameter. Required if `start_number` given.	[optional]
endYear	Integer	Year for `end_number` parameter. Required if `end_number` given.	[optional]
type	DocumentType	Filter documents by type	[optional] [enum: advance, cancellation, cert_of_completion, d_cert_of_completion, dossier, draft, draft_offer, draft_order_form, draft_waybill, invoice, modification, offer, order_form, proforma, receipt, receipt_cancellation, waybill]
query	String	Filter documents by the given text	[optional]
paidStartDate	LocalDate	Filter documents by their payment date.	[optional]
paidEndDate	LocalDate	Filter documents by their payment date.	[optional]
fulfillmentStartDate	LocalDate	Filter documents by their fulfillment date.	[optional]
fulfillmentEndDate	LocalDate	Filter documents by their fulfillment date.	[optional]
lastModifiedDate	String	Filter documents by their last modified date.	[optional]

Return type

DocumentList

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

posPrint

File posPrint(id, size)

Returns a printable POS PDF

Returns a printable POS PDF file of a particular document.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    BigDecimal size = new BigDecimal("58"); // BigDecimal | In which size the POS PDF should be rendered.
    try {
      File result = apiInstance.posPrint(id, size);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#posPrint");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
size	BigDecimal	In which size the POS PDF should be rendered.	[enum: 58, 80]

Return type

File

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

HTTP response details

Status code	Description	Response headers
200	A printable PDF document	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

sendDocument

SendDocument sendDocument(id, sendDocument)

Send invoice to given email adresses.

Returns a list of emails, where the invoice is sent.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    SendDocument sendDocument = new SendDocument(); // SendDocument | List of email-s where you want to send the invoice.
    try {
      SendDocument result = apiInstance.sendDocument(id, sendDocument);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#sendDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
sendDocument	SendDocument	List of email-s where you want to send the invoice.	[optional]

Return type

SendDocument

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of email adresses where the invoice sent.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

updatePayment

List<PaymentHistory> updatePayment(id, paymentHistory)

Update payment history

Update payment history an existing document. Returns a payment history object if the update is succeded.

Example

// 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.DocumentApi;

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");

    DocumentApi apiInstance = new DocumentApi(defaultClient);
    Integer id = 56; // Integer | 
    List<PaymentHistory> paymentHistory = Arrays.asList(); // List<PaymentHistory> | Payment history object that you would like to update.
    try {
      List<PaymentHistory> result = apiInstance.updatePayment(id, paymentHistory);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentApi#updatePayment");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	Integer
paymentHistory	List<PaymentHistory>	Payment history object that you would like to update.

Return type

List<PaymentHistory>

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Payment history updated successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

FilesExpand file tree

DocumentApi.md

Latest commit

History

DocumentApi.md

File metadata and controls

DocumentApi

archiveDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancelDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDocumentFromDraft

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDocumentFromProforma

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createModificationDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createReceipt

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createReceiptFromDraft

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deletePayment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

documentCopy

Example

Parameters