Skip to content

Latest commit

 

History

History
330 lines (234 loc) · 13.3 KB

ObjectVariableexpenseApi.md

File metadata and controls

330 lines (234 loc) · 13.3 KB

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

-(NSURLSessionTask*) variableexpenseCreateObjectV1WithVariableexpenseCreateObjectV1Request: (VariableexpenseCreateObjectV1Request*) variableexpenseCreateObjectV1Request
        completionHandler: (void (^)(VariableexpenseCreateObjectV1Response* output, NSError* error)) handler;

Create a new Variableexpense

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


VariableexpenseCreateObjectV1Request* variableexpenseCreateObjectV1Request = [[VariableexpenseCreateObjectV1Request alloc] init]; // 

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

// Create a new Variableexpense
[apiInstance variableexpenseCreateObjectV1WithVariableexpenseCreateObjectV1Request:variableexpenseCreateObjectV1Request
          completionHandler: ^(VariableexpenseCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectVariableexpenseApi->variableexpenseCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
variableexpenseCreateObjectV1Request VariableexpenseCreateObjectV1Request*

Return type

VariableexpenseCreateObjectV1Response*

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]

variableexpenseEditObjectV1

-(NSURLSessionTask*) variableexpenseEditObjectV1WithPkiVariableexpenseID: (NSNumber*) pkiVariableexpenseID
    variableexpenseEditObjectV1Request: (VariableexpenseEditObjectV1Request*) variableexpenseEditObjectV1Request
        completionHandler: (void (^)(VariableexpenseEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Variableexpense

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* pkiVariableexpenseID = @56; // 
VariableexpenseEditObjectV1Request* variableexpenseEditObjectV1Request = [[VariableexpenseEditObjectV1Request alloc] init]; // 

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

// Edit an existing Variableexpense
[apiInstance variableexpenseEditObjectV1WithPkiVariableexpenseID:pkiVariableexpenseID
              variableexpenseEditObjectV1Request:variableexpenseEditObjectV1Request
          completionHandler: ^(VariableexpenseEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectVariableexpenseApi->variableexpenseEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiVariableexpenseID NSNumber*
variableexpenseEditObjectV1Request VariableexpenseEditObjectV1Request*

Return type

VariableexpenseEditObjectV1Response*

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]

variableexpenseGetAutocompleteV2

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

Retrieve Variableexpenses and IDs

Get the list of Variableexpense 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 Variableexpenses 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)

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

// Retrieve Variableexpenses and IDs
[apiInstance variableexpenseGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(VariableexpenseGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectVariableexpenseApi->variableexpenseGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

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

VariableexpenseGetAutocompleteV2Response*

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]

variableexpenseGetListV1

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

Retrieve Variableexpense list

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

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)

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

// Retrieve Variableexpense list
[apiInstance variableexpenseGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(VariableexpenseGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectVariableexpenseApi->variableexpenseGetListV1: %@", 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

VariableexpenseGetListV1Response*

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]

variableexpenseGetObjectV2

-(NSURLSessionTask*) variableexpenseGetObjectV2WithPkiVariableexpenseID: (NSNumber*) pkiVariableexpenseID
        completionHandler: (void (^)(VariableexpenseGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Variableexpense

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* pkiVariableexpenseID = @56; // 

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

// Retrieve an existing Variableexpense
[apiInstance variableexpenseGetObjectV2WithPkiVariableexpenseID:pkiVariableexpenseID
          completionHandler: ^(VariableexpenseGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectVariableexpenseApi->variableexpenseGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiVariableexpenseID NSNumber*

Return type

VariableexpenseGetObjectV2Response*

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]