ObjectOtherincomeApi

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

Method	HTTP request	Description
otherincomeGetCommunicationCountV1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount	Retrieve Communication count
otherincomeGetCommunicationListV1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList	Retrieve Communication list
otherincomeGetCommunicationrecipientsV1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients	Retrieve Otherincome's Communicationrecipient
otherincomeGetCommunicationsendersV1	GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders	Retrieve Otherincome's Communicationsender
otherincomeGetListV1	GET /1/object/otherincome/getList	Retrieve Otherincome list
otherincomeImportIntoEDMV1	POST /1/object/otherincome/{pkiOtherincomeID}/importIntoEDM	Import attachments into the Otherincome

otherincomeGetCommunicationCountV1

OtherincomeGetCommunicationCountV1Response otherincomeGetCommunicationCountV1(pkiOtherincomeID)

Retrieve Communication count

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    Integer pkiOtherincomeID = 56; // Integer | 
    try {
      OtherincomeGetCommunicationCountV1Response result = apiInstance.otherincomeGetCommunicationCountV1(pkiOtherincomeID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeGetCommunicationCountV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiOtherincomeID	Integer

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	-

otherincomeGetCommunicationListV1

OtherincomeGetCommunicationListV1Response otherincomeGetCommunicationListV1(pkiOtherincomeID)

Retrieve Communication list

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    Integer pkiOtherincomeID = 56; // Integer | 
    try {
      OtherincomeGetCommunicationListV1Response result = apiInstance.otherincomeGetCommunicationListV1(pkiOtherincomeID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeGetCommunicationListV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiOtherincomeID	Integer

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	-

otherincomeGetCommunicationrecipientsV1

OtherincomeGetCommunicationrecipientsV1Response otherincomeGetCommunicationrecipientsV1(pkiOtherincomeID)

Retrieve Otherincome's Communicationrecipient

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    Integer pkiOtherincomeID = 56; // Integer | 
    try {
      OtherincomeGetCommunicationrecipientsV1Response result = apiInstance.otherincomeGetCommunicationrecipientsV1(pkiOtherincomeID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeGetCommunicationrecipientsV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiOtherincomeID	Integer

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	-

otherincomeGetCommunicationsendersV1

OtherincomeGetCommunicationsendersV1Response otherincomeGetCommunicationsendersV1(pkiOtherincomeID)

Retrieve Otherincome's Communicationsender

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    Integer pkiOtherincomeID = 56; // Integer | 
    try {
      OtherincomeGetCommunicationsendersV1Response result = apiInstance.otherincomeGetCommunicationsendersV1(pkiOtherincomeID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeGetCommunicationsendersV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiOtherincomeID	Integer

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	-

otherincomeGetListV1

OtherincomeGetListV1Response otherincomeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Otherincome list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eOtherincomeRemunerationtype | Dollars<br>DollarsTaxesIncluded |

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    String eOrderBy = "pkiOtherincomeID_ASC"; // String | Specify how you want the results to be sorted
    Integer iRowMax = 56; // Integer | 
    Integer iRowOffset = 0; // Integer | 
    HeaderAcceptLanguage acceptLanguage = HeaderAcceptLanguage.fromValue("*"); // HeaderAcceptLanguage | 
    String sFilter = "sFilter_example"; // String | 
    try {
      OtherincomeGetListV1Response result = apiInstance.otherincomeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeGetListV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
eOrderBy	String	Specify how you want the results to be sorted	[optional] [enum: pkiOtherincomeID_ASC, pkiOtherincomeID_DESC, fkiOtherincometypeID_ASC, fkiOtherincometypeID_DESC, sOtherincometypeDescriptionX_ASC, sOtherincometypeDescriptionX_DESC, sOtherincomeDescription_ASC, sOtherincomeDescription_DESC, eOtherincomeRemunerationtype_ASC, eOtherincomeRemunerationtype_DESC, dOtherincomeRemunerationsubtotal_ASC, dOtherincomeRemunerationsubtotal_DESC, dOtherincomeRemunerationtaxes_ASC, dOtherincomeRemunerationtaxes_DESC, dOtherincomeRemunerationtotal_ASC, dOtherincomeRemunerationtotal_DESC, dtOtherincomePaid_ASC, dtOtherincomePaid_DESC, bOtherincomeIsactive_ASC, bOtherincomeIsactive_DESC]
iRowMax	Integer		[optional]
iRowOffset	Integer		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage		[optional] [enum: *, en, fr]
sFilter	String		[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"	-

otherincomeImportIntoEDMV1

OtherincomeImportIntoEDMV1Response otherincomeImportIntoEDMV1(pkiOtherincomeID, otherincomeImportIntoEDMV1Request)

Import attachments into the Otherincome

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectOtherincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // 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");

    ObjectOtherincomeApi apiInstance = new ObjectOtherincomeApi(defaultClient);
    Integer pkiOtherincomeID = 56; // Integer | 
    OtherincomeImportIntoEDMV1Request otherincomeImportIntoEDMV1Request = new OtherincomeImportIntoEDMV1Request(); // OtherincomeImportIntoEDMV1Request | 
    try {
      OtherincomeImportIntoEDMV1Response result = apiInstance.otherincomeImportIntoEDMV1(pkiOtherincomeID, otherincomeImportIntoEDMV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectOtherincomeApi#otherincomeImportIntoEDMV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
pkiOtherincomeID	Integer
otherincomeImportIntoEDMV1Request	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	-

FilesExpand file tree

ObjectOtherincomeApi.md

Latest commit

History

ObjectOtherincomeApi.md

File metadata and controls

ObjectOtherincomeApi

otherincomeGetCommunicationCountV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincomeGetCommunicationListV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincomeGetCommunicationrecipientsV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincomeGetCommunicationsendersV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincomeGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

otherincomeImportIntoEDMV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details