Skip to content

Latest commit

 

History

History
508 lines (407 loc) · 19.5 KB

ObjectVariableexpenseApi.md

File metadata and controls

508 lines (407 loc) · 19.5 KB

eZmaxApi.Api.ObjectVariableexpenseApi

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

Method HTTP request Description
VariableexpenseCreateObjectV1 POST /1/object/variableexpense Create a new Variableexpense
VariableexpenseEditObjectV1 PUT /1/object/variableexpense/{pkiVariableexpenseID} Edit an existing Variableexpense
VariableexpenseGetAutocompleteV2 GET /2/object/variableexpense/getAutocomplete/{sSelector} Retrieve Variableexpenses and IDs
VariableexpenseGetListV1 GET /1/object/variableexpense/getList Retrieve Variableexpense list
VariableexpenseGetObjectV2 GET /2/object/variableexpense/{pkiVariableexpenseID} Retrieve an existing Variableexpense

VariableexpenseCreateObjectV1

VariableexpenseCreateObjectV1Response VariableexpenseCreateObjectV1 (VariableexpenseCreateObjectV1Request variableexpenseCreateObjectV1Request)

Create a new Variableexpense

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 VariableexpenseCreateObjectV1Example
    {
        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 ObjectVariableexpenseApi(config);
            var variableexpenseCreateObjectV1Request = new VariableexpenseCreateObjectV1Request(); // VariableexpenseCreateObjectV1Request | 

            try
            {
                // Create a new Variableexpense
                VariableexpenseCreateObjectV1Response result = apiInstance.VariableexpenseCreateObjectV1(variableexpenseCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectVariableexpenseApi.VariableexpenseCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VariableexpenseCreateObjectV1WithHttpInfo variant

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

try
{
    // Create a new Variableexpense
    ApiResponse<VariableexpenseCreateObjectV1Response> response = apiInstance.VariableexpenseCreateObjectV1WithHttpInfo(variableexpenseCreateObjectV1Request);
    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 ObjectVariableexpenseApi.VariableexpenseCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
variableexpenseCreateObjectV1Request VariableexpenseCreateObjectV1Request

Return type

VariableexpenseCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful response -

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

VariableexpenseEditObjectV1

VariableexpenseEditObjectV1Response VariableexpenseEditObjectV1 (int pkiVariableexpenseID, VariableexpenseEditObjectV1Request variableexpenseEditObjectV1Request)

Edit an existing Variableexpense

Example

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

namespace Example
{
    public class VariableexpenseEditObjectV1Example
    {
        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 ObjectVariableexpenseApi(config);
            var pkiVariableexpenseID = 56;  // int | 
            var variableexpenseEditObjectV1Request = new VariableexpenseEditObjectV1Request(); // VariableexpenseEditObjectV1Request | 

            try
            {
                // Edit an existing Variableexpense
                VariableexpenseEditObjectV1Response result = apiInstance.VariableexpenseEditObjectV1(pkiVariableexpenseID, variableexpenseEditObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectVariableexpenseApi.VariableexpenseEditObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VariableexpenseEditObjectV1WithHttpInfo variant

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

try
{
    // Edit an existing Variableexpense
    ApiResponse<VariableexpenseEditObjectV1Response> response = apiInstance.VariableexpenseEditObjectV1WithHttpInfo(pkiVariableexpenseID, variableexpenseEditObjectV1Request);
    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 ObjectVariableexpenseApi.VariableexpenseEditObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiVariableexpenseID int
variableexpenseEditObjectV1Request VariableexpenseEditObjectV1Request

Return type

VariableexpenseEditObjectV1Response

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 -
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]

VariableexpenseGetAutocompleteV2

VariableexpenseGetAutocompleteV2Response VariableexpenseGetAutocompleteV2 (string sSelector, string? eFilterActive = null, string? sQuery = null, HeaderAcceptLanguage? acceptLanguage = null)

Retrieve Variableexpenses and IDs

Get the list of Variableexpense 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 VariableexpenseGetAutocompleteV2Example
    {
        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 ObjectVariableexpenseApi(config);
            var sSelector = "All";  // string | The type of Variableexpenses 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 Variableexpenses and IDs
                VariableexpenseGetAutocompleteV2Response result = apiInstance.VariableexpenseGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectVariableexpenseApi.VariableexpenseGetAutocompleteV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VariableexpenseGetAutocompleteV2WithHttpInfo variant

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

try
{
    // Retrieve Variableexpenses and IDs
    ApiResponse<VariableexpenseGetAutocompleteV2Response> response = apiInstance.VariableexpenseGetAutocompleteV2WithHttpInfo(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 ObjectVariableexpenseApi.VariableexpenseGetAutocompleteV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sSelector string The type of Variableexpenses 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

VariableexpenseGetAutocompleteV2Response

Authorization

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]

VariableexpenseGetListV1

VariableexpenseGetListV1Response VariableexpenseGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Variableexpense list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |- --|- --| | eVariableexpenseTaxable | Yes
No
Included |

Example

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

namespace Example
{
    public class VariableexpenseGetListV1Example
    {
        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 ObjectVariableexpenseApi(config);
            var eOrderBy = "pkiVariableexpenseID_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 Variableexpense list
                VariableexpenseGetListV1Response result = apiInstance.VariableexpenseGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectVariableexpenseApi.VariableexpenseGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VariableexpenseGetListV1WithHttpInfo variant

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

try
{
    // Retrieve Variableexpense list
    ApiResponse<VariableexpenseGetListV1Response> response = apiInstance.VariableexpenseGetListV1WithHttpInfo(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 ObjectVariableexpenseApi.VariableexpenseGetListV1WithHttpInfo: " + 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

VariableexpenseGetListV1Response

Authorization

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 &quot;Accept: application/json&quot; but the function can only return &quot;Content-type: image/png&quot; -

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

VariableexpenseGetObjectV2

VariableexpenseGetObjectV2Response VariableexpenseGetObjectV2 (int pkiVariableexpenseID)

Retrieve an existing Variableexpense

Example

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

namespace Example
{
    public class VariableexpenseGetObjectV2Example
    {
        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 ObjectVariableexpenseApi(config);
            var pkiVariableexpenseID = 56;  // int | 

            try
            {
                // Retrieve an existing Variableexpense
                VariableexpenseGetObjectV2Response result = apiInstance.VariableexpenseGetObjectV2(pkiVariableexpenseID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectVariableexpenseApi.VariableexpenseGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the VariableexpenseGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Variableexpense
    ApiResponse<VariableexpenseGetObjectV2Response> response = apiInstance.VariableexpenseGetObjectV2WithHttpInfo(pkiVariableexpenseID);
    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 ObjectVariableexpenseApi.VariableexpenseGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiVariableexpenseID int

Return type

VariableexpenseGetObjectV2Response

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]