eZmaxApi.ObjectOtherincomeApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
otherincome_get_communication_count_v1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount	Retrieve Communication count
otherincome_get_communication_list_v1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList	Retrieve Communication list
otherincome_get_communicationrecipients_v1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients	Retrieve Otherincome's Communicationrecipient
otherincome_get_communicationsenders_v1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders	Retrieve Otherincome's Communicationsender
otherincome_get_list_v1	GET /1/object/otherincome/getList	Retrieve Otherincome list
otherincome_import_into_edmv1	POST /1/object/otherincome/{pkiOtherincomeID}/importIntoEDM	Import attachments into the Otherincome

otherincome_get_communication_count_v1

OtherincomeGetCommunicationCountV1Response otherincome_get_communication_count_v1(pki_otherincome_id)

Retrieve Communication count

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.otherincome_get_communication_count_v1_response import OtherincomeGetCommunicationCountV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    pki_otherincome_id = 56 # int | 

    try:
        # Retrieve Communication count
        api_response = api_instance.otherincome_get_communication_count_v1(pki_otherincome_id)
        print("The response of ObjectOtherincomeApi->otherincome_get_communication_count_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_get_communication_count_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_otherincome_id	int

Return type

OtherincomeGetCommunicationCountV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

otherincome_get_communication_list_v1

OtherincomeGetCommunicationListV1Response otherincome_get_communication_list_v1(pki_otherincome_id)

Retrieve Communication list

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.otherincome_get_communication_list_v1_response import OtherincomeGetCommunicationListV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    pki_otherincome_id = 56 # int | 

    try:
        # Retrieve Communication list
        api_response = api_instance.otherincome_get_communication_list_v1(pki_otherincome_id)
        print("The response of ObjectOtherincomeApi->otherincome_get_communication_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_get_communication_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_otherincome_id	int

Return type

OtherincomeGetCommunicationListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

otherincome_get_communicationrecipients_v1

OtherincomeGetCommunicationrecipientsV1Response otherincome_get_communicationrecipients_v1(pki_otherincome_id)

Retrieve Otherincome's Communicationrecipient

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.otherincome_get_communicationrecipients_v1_response import OtherincomeGetCommunicationrecipientsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    pki_otherincome_id = 56 # int | 

    try:
        # Retrieve Otherincome's Communicationrecipient
        api_response = api_instance.otherincome_get_communicationrecipients_v1(pki_otherincome_id)
        print("The response of ObjectOtherincomeApi->otherincome_get_communicationrecipients_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_get_communicationrecipients_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_otherincome_id	int

Return type

OtherincomeGetCommunicationrecipientsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

otherincome_get_communicationsenders_v1

OtherincomeGetCommunicationsendersV1Response otherincome_get_communicationsenders_v1(pki_otherincome_id)

Retrieve Otherincome's Communicationsender

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.otherincome_get_communicationsenders_v1_response import OtherincomeGetCommunicationsendersV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    pki_otherincome_id = 56 # int | 

    try:
        # Retrieve Otherincome's Communicationsender
        api_response = api_instance.otherincome_get_communicationsenders_v1(pki_otherincome_id)
        print("The response of ObjectOtherincomeApi->otherincome_get_communicationsenders_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_get_communicationsenders_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_otherincome_id	int

Return type

OtherincomeGetCommunicationsendersV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

otherincome_get_list_v1

OtherincomeGetListV1Response otherincome_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Otherincome list

Enum values that can be filtered in query parameter sFilter:

Variable	Valid values
eOtherincomeRemunerationtype	Dollars DollarsTaxesIncluded

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.otherincome_get_list_v1_response import OtherincomeGetListV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Otherincome list
        api_response = api_instance.otherincome_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectOtherincomeApi->otherincome_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_get_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
e_order_by	str	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	str		[optional]

Return type

OtherincomeGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

otherincome_import_into_edmv1

OtherincomeImportIntoEDMV1Response otherincome_import_into_edmv1(pki_otherincome_id, otherincome_import_into_edmv1_request)

Import attachments into the Otherincome

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.otherincome_import_into_edmv1_request import OtherincomeImportIntoEDMV1Request
from eZmaxApi.models.otherincome_import_into_edmv1_response import OtherincomeImportIntoEDMV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# 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.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectOtherincomeApi(api_client)
    pki_otherincome_id = 56 # int | 
    otherincome_import_into_edmv1_request = eZmaxApi.OtherincomeImportIntoEDMV1Request() # OtherincomeImportIntoEDMV1Request | 

    try:
        # Import attachments into the Otherincome
        api_response = api_instance.otherincome_import_into_edmv1(pki_otherincome_id, otherincome_import_into_edmv1_request)
        print("The response of ObjectOtherincomeApi->otherincome_import_into_edmv1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectOtherincomeApi->otherincome_import_into_edmv1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_otherincome_id	int
otherincome_import_into_edmv1_request	OtherincomeImportIntoEDMV1Request

Return type

OtherincomeImportIntoEDMV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

FilesExpand file tree

ObjectOtherincomeApi.md

Latest commit

History

ObjectOtherincomeApi.md

File metadata and controls

eZmaxApi.ObjectOtherincomeApi

otherincome_get_communication_count_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincome_get_communication_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincome_get_communicationrecipients_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincome_get_communicationsenders_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincome_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincome_import_into_edmv1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details