Skip to content

Latest commit

 

History

History
171 lines (117 loc) · 5.76 KB

ObjectEzmaxinvoicingApi.md

File metadata and controls

171 lines (117 loc) · 5.76 KB
Raw

EzmaxApi::ObjectEzmaxinvoicingApi

Load the API package

use EzmaxApi::Object::ObjectEzmaxinvoicingApi;

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

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

ezmaxinvoicing_get_autocomplete_v2

EzmaxinvoicingGetAutocompleteV2Response ezmaxinvoicing_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language)

Retrieve Ezmaxinvoicings and IDs

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

Example

use Data::Dumper;
use EzmaxApi::ObjectEzmaxinvoicingApi;
my $api_instance = EzmaxApi::ObjectEzmaxinvoicingApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $s_selector = "s_selector_example"; # string | The type of Ezmaxinvoicings to return
my $e_filter_active = 'Active'; # string | Specify which results we want to display.
my $s_query = "s_query_example"; # string | Allow to filter the returned results
my $accept_language = new EzmaxApi.HeaderAcceptLanguage(); # HeaderAcceptLanguage | 

eval {
    my $result = $api_instance->ezmaxinvoicing_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzmaxinvoicingApi->ezmaxinvoicing_get_autocomplete_v2: $@\n";
}

Parameters

Name Type Description Notes
s_selector string The type of Ezmaxinvoicings to return
e_filter_active string Specify which results we want to display. [optional] [default to 'Active']
s_query string Allow to filter the returned results [optional]
accept_language 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]

ezmaxinvoicing_get_object_v2

EzmaxinvoicingGetObjectV2Response ezmaxinvoicing_get_object_v2(pki_ezmaxinvoicing_id => $pki_ezmaxinvoicing_id)

Retrieve an existing Ezmaxinvoicing

Example

use Data::Dumper;
use EzmaxApi::ObjectEzmaxinvoicingApi;
my $api_instance = EzmaxApi::ObjectEzmaxinvoicingApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_ezmaxinvoicing_id = 56; # int | 

eval {
    my $result = $api_instance->ezmaxinvoicing_get_object_v2(pki_ezmaxinvoicing_id => $pki_ezmaxinvoicing_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzmaxinvoicingApi->ezmaxinvoicing_get_object_v2: $@\n";
}

Parameters

Name Type Description Notes
pki_ezmaxinvoicing_id int

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]

ezmaxinvoicing_get_provisional_v1

EzmaxinvoicingGetProvisionalV1Response ezmaxinvoicing_get_provisional_v1()

Retrieve provisional Ezmaxinvoicing

Example

use Data::Dumper;
use EzmaxApi::ObjectEzmaxinvoicingApi;
my $api_instance = EzmaxApi::ObjectEzmaxinvoicingApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);


eval {
    my $result = $api_instance->ezmaxinvoicing_get_provisional_v1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectEzmaxinvoicingApi->ezmaxinvoicing_get_provisional_v1: $@\n";
}

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]