Skip to content

Latest commit

 

History

History
253 lines (168 loc) · 8.07 KB

ObjectInvoiceApi.md

File metadata and controls

253 lines (168 loc) · 8.07 KB

openapi.api.ObjectInvoiceApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
invoiceGetAttachmentsV1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
invoiceGetCommunicationCountV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationCount Retrieve Communication count
invoiceGetCommunicationListV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
invoiceGetCommunicationrecipientsV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationrecipients Retrieve Invoice's Communicationrecipient
invoiceGetCommunicationsendersV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationsenders Retrieve Invoice's Communicationsender

invoiceGetAttachmentsV1

InvoiceGetAttachmentsV1Response invoiceGetAttachmentsV1(pkiInvoiceID)

Retrieve Invoice's Attachments

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInvoiceApi();
final pkiInvoiceID = 56; // int | 

try {
    final result = api_instance.invoiceGetAttachmentsV1(pkiInvoiceID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInvoiceApi->invoiceGetAttachmentsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInvoiceID 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]

invoiceGetCommunicationCountV1

InvoiceGetCommunicationCountV1Response invoiceGetCommunicationCountV1(pkiInvoiceID)

Retrieve Communication count

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInvoiceApi();
final pkiInvoiceID = 56; // int | 

try {
    final result = api_instance.invoiceGetCommunicationCountV1(pkiInvoiceID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInvoiceApi->invoiceGetCommunicationCountV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInvoiceID 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]

invoiceGetCommunicationListV1

InvoiceGetCommunicationListV1Response invoiceGetCommunicationListV1(pkiInvoiceID)

Retrieve Communication list

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInvoiceApi();
final pkiInvoiceID = 56; // int | 

try {
    final result = api_instance.invoiceGetCommunicationListV1(pkiInvoiceID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInvoiceApi->invoiceGetCommunicationListV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInvoiceID 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]

invoiceGetCommunicationrecipientsV1

InvoiceGetCommunicationrecipientsV1Response invoiceGetCommunicationrecipientsV1(pkiInvoiceID)

Retrieve Invoice's Communicationrecipient

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInvoiceApi();
final pkiInvoiceID = 56; // int | 

try {
    final result = api_instance.invoiceGetCommunicationrecipientsV1(pkiInvoiceID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInvoiceApi->invoiceGetCommunicationrecipientsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInvoiceID 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]

invoiceGetCommunicationsendersV1

InvoiceGetCommunicationsendersV1Response invoiceGetCommunicationsendersV1(pkiInvoiceID)

Retrieve Invoice's Communicationsender

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInvoiceApi();
final pkiInvoiceID = 56; // int | 

try {
    final result = api_instance.invoiceGetCommunicationsendersV1(pkiInvoiceID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInvoiceApi->invoiceGetCommunicationsendersV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInvoiceID 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]