Skip to content

BillingApi.md

Latest commit

 

History

History
146 lines (112 loc) · 5.21 KB

BillingApi.md

File metadata and controls

146 lines (112 loc) · 5.21 KB
Raw

BlueRain.ID4i.Api.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 GetPositionsForOrganization (string organizationId, DateTime? fromDate = null, DateTime? toDate = null)

Get billing positions for a given organization

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetPositionsForOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new BillingApi();
            var organizationId = organizationId_example;  // string | The organization to compute the billing information for
            var fromDate = 2013-10-20T19:20:30+01:00;  // DateTime? | Billing start date (optional) 
            var toDate = 2013-10-20T19:20:30+01:00;  // DateTime? | Billing end date (optional) 

            try
            {
                // Get billing positions for a given organization
                List<BillingPosition> result = apiInstance.GetPositionsForOrganization(organizationId, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BillingApi.GetPositionsForOrganization: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

List

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSumForOrganization

ServiceCosts GetSumForOrganization (string organizationId, DateTime? fromDate = null, DateTime? toDate = null)

Get billing amount of services for a given organization

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetSumForOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new BillingApi();
            var organizationId = organizationId_example;  // string | The organization to compute the billing information for
            var fromDate = 2013-10-20T19:20:30+01:00;  // DateTime? | Billing start date (optional) 
            var toDate = 2013-10-20T19:20:30+01:00;  // DateTime? | Billing end date (optional) 

            try
            {
                // Get billing amount of services for a given organization
                ServiceCosts result = apiInstance.GetSumForOrganization(organizationId, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BillingApi.GetSumForOrganization: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

ServiceCosts

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]