Skip to content

Latest commit

 

History

History
273 lines (183 loc) · 8.2 KB

ObjectInvoiceApi.md

File metadata and controls

273 lines (183 loc) · 8.2 KB

EzmaxApi::ObjectInvoiceApi

Load the API package

use EzmaxApi::Object::ObjectInvoiceApi;

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

Method HTTP request Description
invoice_get_attachments_v1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
invoice_get_communication_count_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationCount Retrieve Communication count
invoice_get_communication_list_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
invoice_get_communicationrecipients_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationrecipients Retrieve Invoice's Communicationrecipient
invoice_get_communicationsenders_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationsenders Retrieve Invoice's Communicationsender

invoice_get_attachments_v1

InvoiceGetAttachmentsV1Response invoice_get_attachments_v1(pki_invoice_id => $pki_invoice_id)

Retrieve Invoice's Attachments

Example

use Data::Dumper;
use EzmaxApi::ObjectInvoiceApi;
my $api_instance = EzmaxApi::ObjectInvoiceApi->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_invoice_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_invoice_id int

Return type

InvoiceGetAttachmentsV1Response

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]

invoice_get_communication_count_v1

InvoiceGetCommunicationCountV1Response invoice_get_communication_count_v1(pki_invoice_id => $pki_invoice_id)

Retrieve Communication count

Example

use Data::Dumper;
use EzmaxApi::ObjectInvoiceApi;
my $api_instance = EzmaxApi::ObjectInvoiceApi->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_invoice_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_invoice_id int

Return type

InvoiceGetCommunicationCountV1Response

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]

invoice_get_communication_list_v1

InvoiceGetCommunicationListV1Response invoice_get_communication_list_v1(pki_invoice_id => $pki_invoice_id)

Retrieve Communication list

Example

use Data::Dumper;
use EzmaxApi::ObjectInvoiceApi;
my $api_instance = EzmaxApi::ObjectInvoiceApi->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_invoice_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_invoice_id int

Return type

InvoiceGetCommunicationListV1Response

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]

invoice_get_communicationrecipients_v1

InvoiceGetCommunicationrecipientsV1Response invoice_get_communicationrecipients_v1(pki_invoice_id => $pki_invoice_id)

Retrieve Invoice's Communicationrecipient

Example

use Data::Dumper;
use EzmaxApi::ObjectInvoiceApi;
my $api_instance = EzmaxApi::ObjectInvoiceApi->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_invoice_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_invoice_id int

Return type

InvoiceGetCommunicationrecipientsV1Response

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]

invoice_get_communicationsenders_v1

InvoiceGetCommunicationsendersV1Response invoice_get_communicationsenders_v1(pki_invoice_id => $pki_invoice_id)

Retrieve Invoice's Communicationsender

Example

use Data::Dumper;
use EzmaxApi::ObjectInvoiceApi;
my $api_instance = EzmaxApi::ObjectInvoiceApi->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_invoice_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_invoice_id int

Return type

InvoiceGetCommunicationsendersV1Response

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]