Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 4.99 KB

DocumentBlockApi.md

File metadata and controls

88 lines (68 loc) · 4.99 KB

DocumentBlockApi

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

Method HTTP request Description
listDocumentBlock GET /document-blocks List all document blocks

listDocumentBlock

DocumentBlockList listDocumentBlock(page, perPage, type)

List all document blocks

Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks 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.DocumentBlockApi;

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

    DocumentBlockApi apiInstance = new DocumentBlockApi(defaultClient);
    Integer page = 56; // Integer | 
    Integer perPage = 25; // Integer | 
    DocumentBlockType type = DocumentBlockType.fromValue("certificate_of_completion"); // DocumentBlockType | Filter document blocks by type
    try {
      DocumentBlockList result = apiInstance.listDocumentBlock(page, perPage, type);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentBlockApi#listDocumentBlock");
      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]
type DocumentBlockType Filter document blocks by type [optional] [enum: certificate_of_completion, dossier, invoice, offer, order_form, receipt, waybill]

Return type

DocumentBlockList

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.