Bill Management TMF Webservices API

CustomerBillManagement

listCustomerBill

List or find CustomerBill objects

This operation list or find CustomerBill entities


/customerBill

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/billmanagementtmfwebservices/v2/customerBill?fields=&limit=&offset=&relatedParty.id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerBillManagementApi;

import java.io.File;
import java.util.*;

public class CustomerBillManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerBillManagementApi apiInstance = new CustomerBillManagementApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String relatedParty.id = relatedParty.id_example; // String | Related party id value
        try {
            array[CustomerBill] result = apiInstance.listCustomerBill(fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerBillManagementApi#listCustomerBill");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerBillManagementApi;

public class CustomerBillManagementApiExample {

    public static void main(String[] args) {
        CustomerBillManagementApi apiInstance = new CustomerBillManagementApi();
        String fields = fields_example; // String | Comma-separated properties to be provided in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        String relatedParty.id = relatedParty.id_example; // String | Related party id value
        try {
            array[CustomerBill] result = apiInstance.listCustomerBill(fields, limit, offset, relatedParty.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerBillManagementApi#listCustomerBill");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *fields = fields_example; // Comma-separated properties to be provided in response (optional)
Integer *limit = 56; // Requested number of resources to be provided in response (optional)
Integer *offset = 56; // Requested index for start of resources to be provided in response (optional)
String *relatedParty.id = relatedParty.id_example; // Related party id value (optional)

CustomerBillManagementApi *apiInstance = [[CustomerBillManagementApi alloc] init];

// List or find CustomerBill objects
[apiInstance listCustomerBillWith:fields
    limit:limit
    offset:offset
    relatedParty.id:relatedParty.id
              completionHandler: ^(array[CustomerBill] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BillManagementTmfWebservicesApi = require('bill_management_tmf_webservices_api');
var defaultClient = BillManagementTmfWebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new BillManagementTmfWebservicesApi.CustomerBillManagementApi()
var opts = { 
  'fields': fields_example, // {{String}} Comma-separated properties to be provided in response
  'limit': 56, // {{Integer}} Requested number of resources to be provided in response
  'offset': 56, // {{Integer}} Requested index for start of resources to be provided in response
  'relatedParty.id': relatedParty.id_example // {{String}} Related party id value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCustomerBill(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCustomerBillExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerBillManagementApi();
            var fields = fields_example;  // String | Comma-separated properties to be provided in response (optional) 
            var limit = 56;  // Integer | Requested number of resources to be provided in response (optional) 
            var offset = 56;  // Integer | Requested index for start of resources to be provided in response (optional) 
            var relatedParty.id = relatedParty.id_example;  // String | Related party id value (optional) 

            try
            {
                // List or find CustomerBill objects
                array[CustomerBill] result = apiInstance.listCustomerBill(fields, limit, offset, relatedParty.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerBillManagementApi.listCustomerBill: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerBillManagementApi();
$fields = fields_example; // String | Comma-separated properties to be provided in response
$limit = 56; // Integer | Requested number of resources to be provided in response
$offset = 56; // Integer | Requested index for start of resources to be provided in response
$relatedParty.id = relatedParty.id_example; // String | Related party id value

try {
    $result = $api_instance->listCustomerBill($fields, $limit, $offset, $relatedParty.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerBillManagementApi->listCustomerBill: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerBillManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerBillManagementApi->new();
my $fields = fields_example; # String | Comma-separated properties to be provided in response
my $limit = 56; # Integer | Requested number of resources to be provided in response
my $offset = 56; # Integer | Requested index for start of resources to be provided in response
my $relatedParty.id = relatedParty.id_example; # String | Related party id value

eval { 
    my $result = $api_instance->listCustomerBill(fields => $fields, limit => $limit, offset => $offset, relatedParty.id => $relatedParty.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerBillManagementApi->listCustomerBill: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerBillManagementApi()
fields = fields_example # String | Comma-separated properties to be provided in response (optional)
limit = 56 # Integer | Requested number of resources to be provided in response (optional)
offset = 56 # Integer | Requested index for start of resources to be provided in response (optional)
relatedParty.id = relatedParty.id_example # String | Related party id value (optional)

try: 
    # List or find CustomerBill objects
    api_response = api_instance.list_customer_bill(fields=fields, limit=limit, offset=offset, relatedParty.id=relatedParty.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerBillManagementApi->listCustomerBill: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Comma-separated properties to be provided in response
limit
Integer (int32)
Requested number of resources to be provided in response
offset
Integer (int32)
Requested index for start of resources to be provided in response
relatedParty.id
String
Related party id value

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error

retrieveCustomerBill

Retrieves a CustomerBill by ID

This operation retrieves a CustomerBill entity. Attribute selection is enabled for all first level attributes.


/customerBill/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json;charset=utf-8"\
"http://localhost:9001/billmanagementtmfwebservices/v2/customerBill/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerBillManagementApi;

import java.io.File;
import java.util.*;

public class CustomerBillManagementApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerBillManagementApi apiInstance = new CustomerBillManagementApi();
        String id = id_example; // String | Identifier of the CustomerBill
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            CustomerBill result = apiInstance.retrieveCustomerBill(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerBillManagementApi#retrieveCustomerBill");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerBillManagementApi;

public class CustomerBillManagementApiExample {

    public static void main(String[] args) {
        CustomerBillManagementApi apiInstance = new CustomerBillManagementApi();
        String id = id_example; // String | Identifier of the CustomerBill
        String fields = fields_example; // String | Comma-separated properties to provide in response
        try {
            CustomerBill result = apiInstance.retrieveCustomerBill(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerBillManagementApi#retrieveCustomerBill");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *id = id_example; // Identifier of the CustomerBill
String *fields = fields_example; // Comma-separated properties to provide in response (optional)

CustomerBillManagementApi *apiInstance = [[CustomerBillManagementApi alloc] init];

// Retrieves a CustomerBill by ID
[apiInstance retrieveCustomerBillWith:id
    fields:fields
              completionHandler: ^(CustomerBill output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BillManagementTmfWebservicesApi = require('bill_management_tmf_webservices_api');
var defaultClient = BillManagementTmfWebservicesApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new BillManagementTmfWebservicesApi.CustomerBillManagementApi()
var id = id_example; // {{String}} Identifier of the CustomerBill
var opts = { 
  'fields': fields_example // {{String}} Comma-separated properties to provide in response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveCustomerBill(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveCustomerBillExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerBillManagementApi();
            var id = id_example;  // String | Identifier of the CustomerBill
            var fields = fields_example;  // String | Comma-separated properties to provide in response (optional) 

            try
            {
                // Retrieves a CustomerBill by ID
                CustomerBill result = apiInstance.retrieveCustomerBill(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerBillManagementApi.retrieveCustomerBill: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerBillManagementApi();
$id = id_example; // String | Identifier of the CustomerBill
$fields = fields_example; // String | Comma-separated properties to provide in response

try {
    $result = $api_instance->retrieveCustomerBill($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerBillManagementApi->retrieveCustomerBill: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerBillManagementApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerBillManagementApi->new();
my $id = id_example; # String | Identifier of the CustomerBill
my $fields = fields_example; # String | Comma-separated properties to provide in response

eval { 
    my $result = $api_instance->retrieveCustomerBill(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerBillManagementApi->retrieveCustomerBill: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerBillManagementApi()
id = id_example # String | Identifier of the CustomerBill
fields = fields_example # String | Comma-separated properties to provide in response (optional)

try: 
    # Retrieves a CustomerBill by ID
    api_response = api_instance.retrieve_customer_bill(id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerBillManagementApi->retrieveCustomerBill: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Identifier of the CustomerBill
Required
Query parameters
Name Description
fields
String
Comma-separated properties to provide in response

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not allowed

Status: 409 - Conflict

Status: 500 - Internal Server Error