Skip to content

ObjectInvoiceApi.md

Latest commit

 

History

History
436 lines (330 loc) · 15.4 KB

ObjectInvoiceApi.md

File metadata and controls

436 lines (330 loc) · 15.4 KB

ObjectInvoiceApi

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

Method HTTP request Description
invoiceGetAttachmentsV1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
invoiceGetCommunicationCountV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationCount Retrieve Communication count
invoiceGetCommunicationListV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
invoiceGetCommunicationrecipientsV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationrecipients Retrieve Invoice's Communicationrecipient
invoiceGetCommunicationsendersV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationsenders Retrieve Invoice's Communicationsender
invoiceImportIntoEDMV1 POST /1/object/invoice/{pkiInvoiceID}/importIntoEDM Import attachments into the Invoice

invoiceGetAttachmentsV1

InvoiceGetAttachmentsV1Response invoiceGetAttachmentsV1(pkiInvoiceID)

Retrieve Invoice's Attachments

Example

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

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    try {
      InvoiceGetAttachmentsV1Response result = apiInstance.invoiceGetAttachmentsV1(pkiInvoiceID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceGetAttachmentsV1");
      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
pkiInvoiceID Integer

Return type

InvoiceGetAttachmentsV1Response

Authorization

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 -

invoiceGetCommunicationCountV1

InvoiceGetCommunicationCountV1Response invoiceGetCommunicationCountV1(pkiInvoiceID)

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.ObjectInvoiceApi;

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    try {
      InvoiceGetCommunicationCountV1Response result = apiInstance.invoiceGetCommunicationCountV1(pkiInvoiceID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceGetCommunicationCountV1");
      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
pkiInvoiceID Integer

Return type

InvoiceGetCommunicationCountV1Response

Authorization

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 -

invoiceGetCommunicationListV1

InvoiceGetCommunicationListV1Response invoiceGetCommunicationListV1(pkiInvoiceID)

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.ObjectInvoiceApi;

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    try {
      InvoiceGetCommunicationListV1Response result = apiInstance.invoiceGetCommunicationListV1(pkiInvoiceID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceGetCommunicationListV1");
      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
pkiInvoiceID Integer

Return type

InvoiceGetCommunicationListV1Response

Authorization

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 -

invoiceGetCommunicationrecipientsV1

InvoiceGetCommunicationrecipientsV1Response invoiceGetCommunicationrecipientsV1(pkiInvoiceID)

Retrieve Invoice's Communicationrecipient

Example

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

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    try {
      InvoiceGetCommunicationrecipientsV1Response result = apiInstance.invoiceGetCommunicationrecipientsV1(pkiInvoiceID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceGetCommunicationrecipientsV1");
      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
pkiInvoiceID Integer

Return type

InvoiceGetCommunicationrecipientsV1Response

Authorization

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 -

invoiceGetCommunicationsendersV1

InvoiceGetCommunicationsendersV1Response invoiceGetCommunicationsendersV1(pkiInvoiceID)

Retrieve Invoice's Communicationsender

Example

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

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    try {
      InvoiceGetCommunicationsendersV1Response result = apiInstance.invoiceGetCommunicationsendersV1(pkiInvoiceID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceGetCommunicationsendersV1");
      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
pkiInvoiceID Integer

Return type

InvoiceGetCommunicationsendersV1Response

Authorization

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 -

invoiceImportIntoEDMV1

InvoiceImportIntoEDMV1Response invoiceImportIntoEDMV1(pkiInvoiceID, invoiceImportIntoEDMV1Request)

Import attachments into the Invoice

Example

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

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");

    ObjectInvoiceApi apiInstance = new ObjectInvoiceApi(defaultClient);
    Integer pkiInvoiceID = 56; // Integer | 
    InvoiceImportIntoEDMV1Request invoiceImportIntoEDMV1Request = new InvoiceImportIntoEDMV1Request(); // InvoiceImportIntoEDMV1Request | 
    try {
      InvoiceImportIntoEDMV1Response result = apiInstance.invoiceImportIntoEDMV1(pkiInvoiceID, invoiceImportIntoEDMV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInvoiceApi#invoiceImportIntoEDMV1");
      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
pkiInvoiceID Integer
invoiceImportIntoEDMV1Request InvoiceImportIntoEDMV1Request

Return type

InvoiceImportIntoEDMV1Response

Authorization

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 -