ObjectEzmaxinvoicingApi.md

ObjectEzmaxinvoicingApi

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

Method	HTTP request	Description
ezmaxinvoicingGetAutocompleteV2	GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector}	Retrieve Ezmaxinvoicings and IDs
ezmaxinvoicingGetObjectV2	GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}	Retrieve an existing Ezmaxinvoicing
ezmaxinvoicingGetProvisionalV1	GET /1/object/ezmaxinvoicing/getProvisional	Retrieve provisional Ezmaxinvoicing

ezmaxinvoicingGetAutocompleteV2

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

Retrieve Ezmaxinvoicings and IDs

Get the list of Ezmaxinvoicing 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 Ezmaxinvoicings 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)

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

// Retrieve Ezmaxinvoicings and IDs
[apiInstance ezmaxinvoicingGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(EzmaxinvoicingGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzmaxinvoicingApi->ezmaxinvoicingGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

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

EzmaxinvoicingGetAutocompleteV2Response*

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]

ezmaxinvoicingGetObjectV2

-(NSURLSessionTask*) ezmaxinvoicingGetObjectV2WithPkiEzmaxinvoicingID: (NSNumber*) pkiEzmaxinvoicingID
        completionHandler: (void (^)(EzmaxinvoicingGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Ezmaxinvoicing

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

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

// Retrieve an existing Ezmaxinvoicing
[apiInstance ezmaxinvoicingGetObjectV2WithPkiEzmaxinvoicingID:pkiEzmaxinvoicingID
          completionHandler: ^(EzmaxinvoicingGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzmaxinvoicingApi->ezmaxinvoicingGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzmaxinvoicingID	NSNumber*

Return type

EzmaxinvoicingGetObjectV2Response*

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]

ezmaxinvoicingGetProvisionalV1

-(NSURLSessionTask*) ezmaxinvoicingGetProvisionalV1WithCompletionHandler: 
        (void (^)(EzmaxinvoicingGetProvisionalV1Response* output, NSError* error)) handler;

Retrieve provisional Ezmaxinvoicing

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



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

// Retrieve provisional Ezmaxinvoicing
[apiInstance ezmaxinvoicingGetProvisionalV1WithCompletionHandler: 
          ^(EzmaxinvoicingGetProvisionalV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzmaxinvoicingApi->ezmaxinvoicingGetProvisionalV1: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

EzmaxinvoicingGetProvisionalV1Response*

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]