Skip to content

BillingApi.md

Latest commit

 

History

History
124 lines (92 loc) · 4.36 KB

BillingApi.md

File metadata and controls

124 lines (92 loc) · 4.36 KB

BillingApi

All URIs are relative to https://backend.id4i.de

Method HTTP request Description
getPositionsForOrganization GET /api/v1/billing/{organizationId}/positions Get billing positions for a given organization
getSumForOrganization GET /api/v1/billing/{organizationId} Get billing amount of services for a given organization

getPositionsForOrganization

List<BillingPosition> getPositionsForOrganization(organizationId, fromDate, toDate)

Get billing positions for a given organization

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.BillingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

BillingApi apiInstance = new BillingApi();
String organizationId = "organizationId_example"; // String | The organization to compute the billing information for
LocalDateTime fromDate = new LocalDateTime(); // LocalDateTime | Billing start date
LocalDateTime toDate = new LocalDateTime(); // LocalDateTime | Billing end date
try {
    List<BillingPosition> result = apiInstance.getPositionsForOrganization(organizationId, fromDate, toDate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BillingApi#getPositionsForOrganization");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
organizationId String The organization to compute the billing information for
fromDate LocalDateTime Billing start date [optional]
toDate LocalDateTime Billing end date [optional]

Return type

List<BillingPosition>

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

getSumForOrganization

ServiceCosts getSumForOrganization(organizationId, fromDate, toDate)

Get billing amount of services for a given organization

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.BillingApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

BillingApi apiInstance = new BillingApi();
String organizationId = "organizationId_example"; // String | The organization to compute the billing information for
LocalDateTime fromDate = new LocalDateTime(); // LocalDateTime | Billing start date
LocalDateTime toDate = new LocalDateTime(); // LocalDateTime | Billing end date
try {
    ServiceCosts result = apiInstance.getSumForOrganization(organizationId, fromDate, toDate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BillingApi#getSumForOrganization");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
organizationId String The organization to compute the billing information for
fromDate LocalDateTime Billing start date [optional]
toDate LocalDateTime Billing end date [optional]

Return type

ServiceCosts

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json