Skip to content

Latest commit

 

History

History
267 lines (186 loc) · 9.62 KB

ObjectPaymenttermApi.md

File metadata and controls

267 lines (186 loc) · 9.62 KB

openapi.api.ObjectPaymenttermApi

Load the API package

import 'package:openapi/api.dart';

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)

Create a new Paymentterm

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

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectPaymenttermApi();
final paymenttermCreateObjectV1Request = PaymenttermCreateObjectV1Request(); // PaymenttermCreateObjectV1Request | 

try {
    final result = api_instance.paymenttermCreateObjectV1(paymenttermCreateObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectPaymenttermApi->paymenttermCreateObjectV1: $e\n');
}

Parameters

Name Type Description Notes
paymenttermCreateObjectV1Request PaymenttermCreateObjectV1Request

Return type

PaymenttermCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

paymenttermEditObjectV1

PaymenttermEditObjectV1Response paymenttermEditObjectV1(pkiPaymenttermID, paymenttermEditObjectV1Request)

Edit an existing Paymentterm

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectPaymenttermApi();
final pkiPaymenttermID = 56; // int | 
final paymenttermEditObjectV1Request = PaymenttermEditObjectV1Request(); // PaymenttermEditObjectV1Request | 

try {
    final result = api_instance.paymenttermEditObjectV1(pkiPaymenttermID, paymenttermEditObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectPaymenttermApi->paymenttermEditObjectV1: $e\n');
}

Parameters

Name Type Description Notes
pkiPaymenttermID int
paymenttermEditObjectV1Request PaymenttermEditObjectV1Request

Return type

PaymenttermEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

paymenttermGetAutocompleteV2

PaymenttermGetAutocompleteV2Response paymenttermGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Paymentterms and IDs

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

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectPaymenttermApi();
final sSelector = sSelector_example; // String | The type of Paymentterms to return
final eFilterActive = eFilterActive_example; // String | Specify which results we want to display.
final sQuery = sQuery_example; // String | Allow to filter the returned results
final acceptLanguage = ; // HeaderAcceptLanguage | 

try {
    final result = api_instance.paymenttermGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    print(result);
} catch (e) {
    print('Exception when calling ObjectPaymenttermApi->paymenttermGetAutocompleteV2: $e\n');
}

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

Authorization

HTTP request headers

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

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

paymenttermGetListV1

PaymenttermGetListV1Response paymenttermGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Paymentterm list

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectPaymenttermApi();
final eOrderBy = eOrderBy_example; // String | Specify how you want the results to be sorted
final iRowMax = 56; // int | 
final iRowOffset = 56; // int | 
final acceptLanguage = ; // HeaderAcceptLanguage | 
final sFilter = sFilter_example; // String | 

try {
    final result = api_instance.paymenttermGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    print(result);
} catch (e) {
    print('Exception when calling ObjectPaymenttermApi->paymenttermGetListV1: $e\n');
}

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

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

paymenttermGetObjectV2

PaymenttermGetObjectV2Response paymenttermGetObjectV2(pkiPaymenttermID)

Retrieve an existing Paymentterm

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectPaymenttermApi();
final pkiPaymenttermID = 56; // int | 

try {
    final result = api_instance.paymenttermGetObjectV2(pkiPaymenttermID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectPaymenttermApi->paymenttermGetObjectV2: $e\n');
}

Parameters

Name Type Description Notes
pkiPaymenttermID int

Return type

PaymenttermGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

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