eZmaxApi.Api.ObjectPaymenttermApi

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

Method	HTTP request	Description
PaymenttermCreateObjectV1	POST /1/object/paymentterm	Create a new Paymentterm
PaymenttermEditObjectV1	PUT /1/object/paymentterm/{pkiPaymenttermID}	Edit an existing Paymentterm
PaymenttermGetAutocompleteV2	GET /2/object/paymentterm/getAutocomplete/{sSelector}	Retrieve Paymentterms and IDs
PaymenttermGetListV1	GET /1/object/paymentterm/getList	Retrieve Paymentterm list
PaymenttermGetObjectV2	GET /2/object/paymentterm/{pkiPaymenttermID}	Retrieve an existing Paymentterm

PaymenttermCreateObjectV1

PaymenttermCreateObjectV1Response PaymenttermCreateObjectV1 (PaymenttermCreateObjectV1Request paymenttermCreateObjectV1Request)

Create a new Paymentterm

The endpoint allows to create one or many elements at once.

Example

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

namespace Example
{
    public class PaymenttermCreateObjectV1Example
    {
        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 ObjectPaymenttermApi(config);
            var paymenttermCreateObjectV1Request = new PaymenttermCreateObjectV1Request(); // PaymenttermCreateObjectV1Request | 

            try
            {
                // Create a new Paymentterm
                PaymenttermCreateObjectV1Response result = apiInstance.PaymenttermCreateObjectV1(paymenttermCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectPaymenttermApi.PaymenttermCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PaymenttermCreateObjectV1WithHttpInfo variant

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

try
{
    // Create a new Paymentterm
    ApiResponse<PaymenttermCreateObjectV1Response> response = apiInstance.PaymenttermCreateObjectV1WithHttpInfo(paymenttermCreateObjectV1Request);
    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 ObjectPaymenttermApi.PaymenttermCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
paymenttermCreateObjectV1Request	PaymenttermCreateObjectV1Request

Return type

PaymenttermCreateObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

PaymenttermEditObjectV1

PaymenttermEditObjectV1Response PaymenttermEditObjectV1 (int pkiPaymenttermID, PaymenttermEditObjectV1Request paymenttermEditObjectV1Request)

Edit an existing Paymentterm

Example

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

namespace Example
{
    public class PaymenttermEditObjectV1Example
    {
        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 ObjectPaymenttermApi(config);
            var pkiPaymenttermID = 56;  // int | 
            var paymenttermEditObjectV1Request = new PaymenttermEditObjectV1Request(); // PaymenttermEditObjectV1Request | 

            try
            {
                // Edit an existing Paymentterm
                PaymenttermEditObjectV1Response result = apiInstance.PaymenttermEditObjectV1(pkiPaymenttermID, paymenttermEditObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectPaymenttermApi.PaymenttermEditObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PaymenttermEditObjectV1WithHttpInfo variant

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

try
{
    // Edit an existing Paymentterm
    ApiResponse<PaymenttermEditObjectV1Response> response = apiInstance.PaymenttermEditObjectV1WithHttpInfo(pkiPaymenttermID, paymenttermEditObjectV1Request);
    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 ObjectPaymenttermApi.PaymenttermEditObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiPaymenttermID	int
paymenttermEditObjectV1Request	PaymenttermEditObjectV1Request

Return type

PaymenttermEditObjectV1Response

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	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

PaymenttermGetAutocompleteV2

PaymenttermGetAutocompleteV2Response PaymenttermGetAutocompleteV2 (string sSelector, string? eFilterActive = null, string? sQuery = null, HeaderAcceptLanguage? acceptLanguage = null)

Retrieve Paymentterms and IDs

Get the list of Paymentterm to be used in a dropdown or autocomplete control.

Example

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

namespace Example
{
    public class PaymenttermGetAutocompleteV2Example
    {
        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 ObjectPaymenttermApi(config);
            var sSelector = "All";  // string | The type of Paymentterms to return
            var eFilterActive = "All";  // string? | Specify which results we want to display. (optional)  (default to Active)
            var sQuery = "sQuery_example";  // string? | Allow to filter the returned results (optional) 
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 

            try
            {
                // Retrieve Paymentterms and IDs
                PaymenttermGetAutocompleteV2Response result = apiInstance.PaymenttermGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectPaymenttermApi.PaymenttermGetAutocompleteV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PaymenttermGetAutocompleteV2WithHttpInfo variant

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

try
{
    // Retrieve Paymentterms and IDs
    ApiResponse<PaymenttermGetAutocompleteV2Response> response = apiInstance.PaymenttermGetAutocompleteV2WithHttpInfo(sSelector, eFilterActive, sQuery, acceptLanguage);
    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 ObjectPaymenttermApi.PaymenttermGetAutocompleteV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
sSelector	string	The type of Paymentterms to return
eFilterActive	string?	Specify which results we want to display.	[optional] [default to Active]
sQuery	string?	Allow to filter the returned results	[optional]
acceptLanguage	HeaderAcceptLanguage?		[optional]

Return type

PaymenttermGetAutocompleteV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

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

PaymenttermGetListV1

PaymenttermGetListV1Response PaymenttermGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Paymentterm list

Example

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

namespace Example
{
    public class PaymenttermGetListV1Example
    {
        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 ObjectPaymenttermApi(config);
            var eOrderBy = "pkiPaymenttermID_ASC";  // string? | Specify how you want the results to be sorted (optional) 
            var iRowMax = 56;  // int? |  (optional) 
            var iRowOffset = 0;  // int? |  (optional)  (default to 0)
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 
            var sFilter = "sFilter_example";  // string? |  (optional) 

            try
            {
                // Retrieve Paymentterm list
                PaymenttermGetListV1Response result = apiInstance.PaymenttermGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectPaymenttermApi.PaymenttermGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PaymenttermGetListV1WithHttpInfo variant

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

try
{
    // Retrieve Paymentterm list
    ApiResponse<PaymenttermGetListV1Response> response = apiInstance.PaymenttermGetListV1WithHttpInfo(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    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 ObjectPaymenttermApi.PaymenttermGetListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
eOrderBy	string?	Specify how you want the results to be sorted	[optional]
iRowMax	int?		[optional]
iRowOffset	int?		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage?		[optional]
sFilter	string?		[optional]

Return type

PaymenttermGetListV1Response

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]

PaymenttermGetObjectV2

PaymenttermGetObjectV2Response PaymenttermGetObjectV2 (int pkiPaymenttermID)

Retrieve an existing Paymentterm

Example

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

namespace Example
{
    public class PaymenttermGetObjectV2Example
    {
        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 ObjectPaymenttermApi(config);
            var pkiPaymenttermID = 56;  // int | 

            try
            {
                // Retrieve an existing Paymentterm
                PaymenttermGetObjectV2Response result = apiInstance.PaymenttermGetObjectV2(pkiPaymenttermID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectPaymenttermApi.PaymenttermGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PaymenttermGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Paymentterm
    ApiResponse<PaymenttermGetObjectV2Response> response = apiInstance.PaymenttermGetObjectV2WithHttpInfo(pkiPaymenttermID);
    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 ObjectPaymenttermApi.PaymenttermGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiPaymenttermID	int

Return type

PaymenttermGetObjectV2Response

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]

Files

ObjectPaymenttermApi.md

Latest commit

History

ObjectPaymenttermApi.md

File metadata and controls

eZmaxApi.Api.ObjectPaymenttermApi

PaymenttermCreateObjectV1

Example

Using the PaymenttermCreateObjectV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PaymenttermEditObjectV1

Example

Using the PaymenttermEditObjectV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PaymenttermGetAutocompleteV2

Example

Using the PaymenttermGetAutocompleteV2WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PaymenttermGetListV1

Example

Using the PaymenttermGetListV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PaymenttermGetObjectV2

Example

Using the PaymenttermGetObjectV2WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details