Skip to content

Latest commit

 

History

History
164 lines (110 loc) · 5.25 KB

CompaniesApi.md

File metadata and controls

164 lines (110 loc) · 5.25 KB

fattureincloud_python_sdk.CompaniesApi

All URIs are relative to https://api-v2.fattureincloud.it

Method HTTP request Description
get_company_info GET /c/{company_id}/company/info Get Company Info
get_company_plan_usage GET /c/{company_id}/company/plan_usage Get Company Plan Usage

get_company_info

GetCompanyInfoResponse get_company_info(company_id)

Get Company Info

Gets the company detailed info.

Example

  • OAuth Authentication (OAuth2AuthenticationCodeFlow):
import fattureincloud_python_sdk
from fattureincloud_python_sdk.models.get_company_info_response import GetCompanyInfoResponse
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.CompaniesApi(api_client)
    company_id = 12345 # int | The ID of the company.

    try:
        # Get Company Info
        api_response = api_instance.get_company_info(company_id)
        print("The response of CompaniesApi->get_company_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->get_company_info: %s\n" % e)

Parameters

Name Type Description Notes
company_id int The ID of the company.

Return type

GetCompanyInfoResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Company info. -
401 Unauthorized. -

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

get_company_plan_usage

GetCompanyPlanUsageResponse get_company_plan_usage(company_id, category)

Get Company Plan Usage

Gets the company limits usage.

Example

  • OAuth Authentication (OAuth2AuthenticationCodeFlow):
import fattureincloud_python_sdk
from fattureincloud_python_sdk.models.get_company_plan_usage_response import GetCompanyPlanUsageResponse
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.CompaniesApi(api_client)
    company_id = 12345 # int | The ID of the company.
    category = 'category_example' # str | Category

    try:
        # Get Company Plan Usage
        api_response = api_instance.get_company_plan_usage(company_id, category)
        print("The response of CompaniesApi->get_company_plan_usage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->get_company_plan_usage: %s\n" % e)

Parameters

Name Type Description Notes
company_id int The ID of the company.
category str Category

Return type

GetCompanyPlanUsageResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Example response -
401 Unauthorized. -

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