PartnerApi

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

Method	HTTP request	Description
createPartner	POST /partners	Create a partner
deletePartner	DELETE /partners/{id}	Delete a partner
getPartner	GET /partners/{id}	Retrieve a partner
listPartner	GET /partners	List all partners
updatePartner	PUT /partners/{id}	Update a partner

createPartner

Partner createPartner(partner)

Create a partner

Create a new partner. Returns a partner 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.PartnerApi;

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

    PartnerApi apiInstance = new PartnerApi(defaultClient);
    Partner partner = new Partner(); // Partner | Partner object that you would like to store.
    try {
      Partner result = apiInstance.createPartner(partner);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PartnerApi#createPartner");
      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
partner	Partner	Partner object that you would like to store.

Return type

Partner

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Partner 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.

deletePartner

deletePartner(id)

Delete a partner

Delete an existing partner.

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.PartnerApi;

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

    PartnerApi apiInstance = new PartnerApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      apiInstance.deletePartner(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling PartnerApi#deletePartner");
      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	Partner 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.

getPartner

Partner getPartner(id)

Retrieve a partner

Retrieves the details of an existing partner.

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.PartnerApi;

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

    PartnerApi apiInstance = new PartnerApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      Partner result = apiInstance.getPartner(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PartnerApi#getPartner");
      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

Partner

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.

listPartner

PartnerList listPartner(page, perPage, query)

List all partners

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

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

    PartnerApi apiInstance = new PartnerApi(defaultClient);
    Integer page = 56; // Integer | 
    Integer perPage = 25; // Integer | 
    String query = "query_example"; // String | 
    try {
      PartnerList result = apiInstance.listPartner(page, perPage, query);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PartnerApi#listPartner");
      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	Notes
page	Integer	[optional]
perPage	Integer	[optional] [default to 25]
query	String	[optional]

Return type

PartnerList

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.

updatePartner

Partner updatePartner(id, partner)

Update a partner

Update an existing partner. Returns a partner 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.PartnerApi;

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

    PartnerApi apiInstance = new PartnerApi(defaultClient);
    Integer id = 56; // Integer | 
    Partner partner = new Partner(); // Partner | Partner object that you would like to update.
    try {
      Partner result = apiInstance.updatePartner(id, partner);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PartnerApi#updatePartner");
      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
partner	Partner	Partner object that you would like to update.

Return type

Partner

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Partner 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PartnerApi

createPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deletePartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updatePartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

PartnerApi.md

Latest commit

History

PartnerApi.md

File metadata and controls

PartnerApi

createPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deletePartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listPartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updatePartner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details