Skip to content

Latest commit

 

History

History
328 lines (233 loc) · 12.7 KB

ObjectPaymenttermApi.md

File metadata and controls

328 lines (233 loc) · 12.7 KB
Raw

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

-(NSURLSessionTask*) paymenttermCreateObjectV1WithPaymenttermCreateObjectV1Request: (PaymenttermCreateObjectV1Request*) paymenttermCreateObjectV1Request
        completionHandler: (void (^)(PaymenttermCreateObjectV1Response* output, NSError* error)) handler;

Create a new Paymentterm

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


PaymenttermCreateObjectV1Request* paymenttermCreateObjectV1Request = [[PaymenttermCreateObjectV1Request alloc] init]; // 

ObjectPaymenttermApi*apiInstance = [[ObjectPaymenttermApi alloc] init];

// Create a new Paymentterm
[apiInstance paymenttermCreateObjectV1WithPaymenttermCreateObjectV1Request:paymenttermCreateObjectV1Request
          completionHandler: ^(PaymenttermCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectPaymenttermApi->paymenttermCreateObjectV1: %@", error);
                        }
                    }];

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

-(NSURLSessionTask*) paymenttermEditObjectV1WithPkiPaymenttermID: (NSNumber*) pkiPaymenttermID
    paymenttermEditObjectV1Request: (PaymenttermEditObjectV1Request*) paymenttermEditObjectV1Request
        completionHandler: (void (^)(PaymenttermEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Paymentterm

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiPaymenttermID = @56; // 
PaymenttermEditObjectV1Request* paymenttermEditObjectV1Request = [[PaymenttermEditObjectV1Request alloc] init]; // 

ObjectPaymenttermApi*apiInstance = [[ObjectPaymenttermApi alloc] init];

// Edit an existing Paymentterm
[apiInstance paymenttermEditObjectV1WithPkiPaymenttermID:pkiPaymenttermID
              paymenttermEditObjectV1Request:paymenttermEditObjectV1Request
          completionHandler: ^(PaymenttermEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectPaymenttermApi->paymenttermEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiPaymenttermID NSNumber*
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

-(NSURLSessionTask*) paymenttermGetAutocompleteV2WithSSelector: (NSString*) sSelector
    eFilterActive: (NSString*) eFilterActive
    sQuery: (NSString*) sQuery
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
        completionHandler: (void (^)(PaymenttermGetAutocompleteV2Response* output, NSError* error)) handler;

Retrieve Paymentterms and IDs

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* sSelector = @"sSelector_example"; // The type of Paymentterms to return
NSString* eFilterActive = @"Active"; // Specify which results we want to display. (optional) (default to @"Active")
NSString* sQuery = @"sQuery_example"; // Allow to filter the returned results (optional)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)

ObjectPaymenttermApi*apiInstance = [[ObjectPaymenttermApi alloc] init];

// Retrieve Paymentterms and IDs
[apiInstance paymenttermGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(PaymenttermGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectPaymenttermApi->paymenttermGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
sSelector NSString* The type of Paymentterms to return
eFilterActive NSString* Specify which results we want to display. [optional] [default to @"Active"]
sQuery NSString* 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

-(NSURLSessionTask*) paymenttermGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(PaymenttermGetListV1Response* output, NSError* error)) handler;

Retrieve Paymentterm list

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

ObjectPaymenttermApi*apiInstance = [[ObjectPaymenttermApi alloc] init];

// Retrieve Paymentterm list
[apiInstance paymenttermGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(PaymenttermGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectPaymenttermApi->paymenttermGetListV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
eOrderBy NSString* Specify how you want the results to be sorted [optional]
iRowMax NSNumber* [optional]
iRowOffset NSNumber* [optional] [default to @0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter NSString* [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

-(NSURLSessionTask*) paymenttermGetObjectV2WithPkiPaymenttermID: (NSNumber*) pkiPaymenttermID
        completionHandler: (void (^)(PaymenttermGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Paymentterm

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiPaymenttermID = @56; // 

ObjectPaymenttermApi*apiInstance = [[ObjectPaymenttermApi alloc] init];

// Retrieve an existing Paymentterm
[apiInstance paymenttermGetObjectV2WithPkiPaymenttermID:pkiPaymenttermID
          completionHandler: ^(PaymenttermGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectPaymenttermApi->paymenttermGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiPaymenttermID NSNumber*

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]