Skip to content

Latest commit

 

History

History
199 lines (158 loc) · 6.69 KB

ObjectInvoiceApi.md

File metadata and controls

199 lines (158 loc) · 6.69 KB
Raw

eZmaxApi.Api.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
InvoiceGetCommunicationListV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list

InvoiceGetAttachmentsV1

InvoiceGetAttachmentsV1Response InvoiceGetAttachmentsV1 (int pkiInvoiceID)

Retrieve Invoice's Attachments

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class InvoiceGetAttachmentsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectInvoiceApi(config);
            var pkiInvoiceID = 56;  // int | 

            try
            {
                // Retrieve Invoice's Attachments
                InvoiceGetAttachmentsV1Response result = apiInstance.InvoiceGetAttachmentsV1(pkiInvoiceID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectInvoiceApi.InvoiceGetAttachmentsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the InvoiceGetAttachmentsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve Invoice's Attachments
    ApiResponse<InvoiceGetAttachmentsV1Response> response = apiInstance.InvoiceGetAttachmentsV1WithHttpInfo(pkiInvoiceID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectInvoiceApi.InvoiceGetAttachmentsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiInvoiceID int

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 -

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

InvoiceGetCommunicationListV1

InvoiceGetCommunicationListV1Response InvoiceGetCommunicationListV1 (int pkiInvoiceID)

Retrieve Communication list

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class InvoiceGetCommunicationListV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectInvoiceApi(config);
            var pkiInvoiceID = 56;  // int | 

            try
            {
                // Retrieve Communication list
                InvoiceGetCommunicationListV1Response result = apiInstance.InvoiceGetCommunicationListV1(pkiInvoiceID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectInvoiceApi.InvoiceGetCommunicationListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the InvoiceGetCommunicationListV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve Communication list
    ApiResponse<InvoiceGetCommunicationListV1Response> response = apiInstance.InvoiceGetCommunicationListV1WithHttpInfo(pkiInvoiceID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectInvoiceApi.InvoiceGetCommunicationListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiInvoiceID int

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 -

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